Shops > Shops
Commerce APIShopsShops

Shops

To fully use the platform, you'll need to establish a shop. Once logged in, you can either create a new shop using the shopsCreate API or collaborate on an existing shop if you've been extended an invite.

Keep in mind that certain choices made during shop creation are permanent and can't be altered later. This includes designating the shop's primary currency and determining if the shop is a test shop or not. For non-test shops, a change of plan is only possible once a payment method has been added.

The majority of shop settings are accessible through their dedicated API: ShopSettings, shopSettings, shopSettingsCreate.

To view all shops where you have permission to work, use the shopsPage API.

When a shop is deleted, it remains in hibernation for up to 60 days before being permanently removed. During this window, you have the opportunity to restore it by clearing any outstanding balance or updating the payment method on file.

Endpoints

EndpointDescriptionJSON API
shopsGet a specific shopGET:shops.json
shopsAcceptOwnershipAccept shop ownershipPOST:shops/accept_ownership.json
shopsCreateCreate a shopPOST:shops.json
shopsDeleteDelete a shopDELETE:shops.json
shopsDeleteInitRequest shop deletionPOST:shops/delete_init.json
shopsDropCacheDrop shopfronts cachePOST:shops/drop_cache.json
shopsMatchingPriceListsGet currently matching price listsGET:shops/matching_price_lists.json
shopsModifyModify a shopPOST:shops.json
shopsPageGet a list of shopsGET:shops/page.json
shopsPreferencesGet shop preferencesGET:shops/preferences.json
shopsPreferencesCreateSave shop preferencesPOST:shops/preferences.json
shopsRestoreUndo shop deletionPOST:shops/restore.json
shopsSettingsGet shop settingsGET:shops/settings.json
shopsSettingsCreateModify shop settingsPOST:shops/settings.json
shopsSynonymSettingsGet synonym settingsGET:shops/synonym_settings.json
shopsSynonymSettingsCreateModify synonym settingsPOST:shops/synonym_settings.json
shopsSynonymSettingsTestTest synonym settingsGET:shops/synonym_settings/test.json
shopsTransferOwnershipTransfer shop ownershipPOST:shops/transfer_ownership.json
shopsTransferOwnershipInitRequest shop ownership transferPOST:shops/transfer_ownership_init.json

Types

Types
MatchingPriceLists
Shop
ShopCreate
ShopDeleteReasonParam
ShopModify
ShopSettings
ShopSettingsCreate
ShopShortPage
SynonymSettings
SynonymSettingsCreate
UIPreference
UIPreferenceCreate