To fully utilize 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, utilize 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
Endpoint | Description |
---|---|
shops | Get a specific shop |
shopsCreate | Create a shop |
shopsDelete | Delete a shop |
shopsDropCache | Drop shopfronts cache |
shopsModify | Modify a shop |
shopsPage | Get a list of shops |
shopsPreferences | Get shop preferences |
shopsPreferencesCreate | Save shop preferences |
shopsSettings | Get shop settings |
shopsSettingsCreate | Modify shop settings |
Types
Types |
---|
Shop |
ShopCreate |
ShopDeleteReasonParam |
ShopModify |
ShopSettings |
ShopSettingsCreate |
ShopShortPage |
UIPreference |
UIPreferenceCreate |