Management API contract
Complete HTTP contract for trusted catalog, commerce, DAM administration, and operator routes.
- Updated
- Apr 26, 2026
Use this contract when you need exact endpoint paths, methods, parameters, request bodies, responses, schemas, and status codes.
- Public contract file: /swagger/management-api.json
Use the operation pages for implementation guidance and this contract file for exact HTTP details.
Operation identity
When an operation page says the OpenAPI contract does not document an Operation ID, cite the stable operation key instead. Stable operation keys use the API, HTTP method, and path, so they identify an endpoint without pretending the contract publishes an operationId.
Registered routes
Use this API-first route list when you already know the owning API and need to find the exact operation page. Routes are grouped by resource so Management, Shopper, Auth, DAM, and Integrations operations stay distinct.
Attribute Template Fields
- PUT
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/field- Create or update attribute template field - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/field/\{attribute_template_field_key\}- Delete attribute template field
Attribute Templates
- GET
/api/v1/\{team_slug\}/\{app_slug\}/attributes- List attribute templates - POST
/api/v1/\{team_slug\}/\{app_slug\}/attributes- Create attribute template - GET
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}- Get attribute template - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}- Delete attribute template - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}- Update attribute template - POST
/api/v1/\{team_slug\}/\{app_slug\}/attributes/bulk- Bulk Create Attribute Templates
Attributes
- POST
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}- Create attribute - GET
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}- Get attribute - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}- Delete attribute - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}- Update attribute - PUT
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}/link/\{attribute_template_key_2\}/\{attribute_key_2\}- Link attributes - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}/link/\{attribute_template_key_2\}/\{attribute_key_2\}- Delete attribute link - PUT
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}/relationship- Create attribute relationship - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}/relationship- Delete attribute relationship - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/\{attribute_key\}/value/\{field_key\}- Delete attribute value - POST
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/bulk- Bulk Create Attributes - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/bulk- Bulk Delete Attributes - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/attributes/\{attribute_template_key\}/bulk- Bulk Update Attributes - POST
/api/v1/\{team_slug\}/\{app_slug\}/attributes/relationships/bulk- Bulk Create Attribute-Item Relationships - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/attributes/relationships/bulk- Bulk Delete Attribute-Item Relationships - GET
/api/v1/\{team_slug\}/\{app_slug\}/attributes/values- List application attributes
Brands
- GET
/api/v1/\{team_slug\}/\{app_slug\}/brands- List all brands - POST
/api/v1/\{team_slug\}/\{app_slug\}/brands- Create a new brand - GET
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}- Retrieve a brand by ID - PUT
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}- Update an existing brand - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}- Delete a brand - GET
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}/series- List all series for a brand - POST
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}/series- Create a new series under a brand - GET
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}/series/\{series_id\}- Retrieve a series by ID - PUT
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}/series/\{series_id\}- Update an existing series - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}/series/\{series_id\}- Delete a series
Bundle Rules
- GET
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}/rules- List all bundle rules - POST
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}/rules- Create a bundle rule - GET
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}/rules/\{rule_id\}- Get a bundle rule - PUT
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}/rules/\{rule_id\}- Update a bundle rule - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}/rules/\{rule_id\}- Delete a bundle rule
Categories
- GET
/api/v1/\{team_slug\}/\{app_slug\}/categories- List Categories - POST
/api/v1/\{team_slug\}/\{app_slug\}/categories- Create Category - GET
/api/v1/\{team_slug\}/\{app_slug\}/categories/\{category_id\}- Get Category - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/categories/\{category_id\}- Delete Category - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/categories/\{category_id\}- Update Category - GET
/api/v1/\{team_slug\}/\{app_slug\}/categories/\{category_id\}/products- Get Category Products - POST
/api/v1/\{team_slug\}/\{app_slug\}/categories/bulk- Bulk Create Categories - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/categories/bulk- Bulk Delete Categories - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/categories/bulk- Bulk Update Categories - POST
/api/v1/\{team_slug\}/\{app_slug\}/categories/products/bulk- Bulk Add Products to Categories - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/categories/products/bulk- Bulk Remove Products from Categories - GET
/api/v1/\{team_slug\}/\{app_slug\}/categories/tree- Get Category Tree
Channels
- GET
/api/v1/\{team_slug\}/\{app_slug\}/channels- List channels - POST
/api/v1/\{team_slug\}/\{app_slug\}/channels- Create a channel - GET
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}- Get a channel - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}- Delete a channel - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}- Update a channel - POST
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content- Create Channel Content Override - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content/\{content_id\}- Delete Channel Content Override - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content/\{content_id\}- Update Channel Content Override - POST
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content/bulk- Bulk Create Channel Content Overrides - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content/bulk- Bulk Update Channel Content Overrides - GET
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/content/parent/\{parent_id\}- List Channel Content Overrides by Parent - POST
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products- Bulk add products to channel - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products- Bulk remove products from channel - PUT
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products/\{product_id\}- Add product to channel - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products/\{product_id\}- Remove product from channel - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/products/\{product_id\}/status- Set product channel status
Collections
- GET
/api/v1/\{team_slug\}/\{app_slug\}/collections- List all collections - POST
/api/v1/\{team_slug\}/\{app_slug\}/collections- Create a new collection - GET
/api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}- Get a collection by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}- Delete a collection - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}- Update a collection - GET
/api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}/products- List products in a collection - PUT
/api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}/products- Add products to collection - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}/products- Remove products from collection - POST
/api/v1/\{team_slug\}/\{app_slug\}/collections/bulk- Bulk create collections - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/collections/bulk- Bulk delete collections - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/collections/bulk- Bulk update collections - POST
/api/v1/\{team_slug\}/\{app_slug\}/collections/products/bulk- Bulk add products to collections - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/collections/products/bulk- Bulk remove products from collections - GET
/api/v1/\{team_slug\}/\{app_slug\}/collections/tree- Get collection tree
Collections V2
- GET
/api/v2/\{team_slug\}/\{app_slug\}/collections- Get collections - POST
/api/v2/\{team_slug\}/\{app_slug\}/collections- Create collections - DELETE
/api/v2/\{team_slug\}/\{app_slug\}/collections- Delete collections - PATCH
/api/v2/\{team_slug\}/\{app_slug\}/collections- Patch collections - GET
/api/v2/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}- Get collection - GET
/api/v2/\{team_slug\}/\{app_slug\}/collections/tree- Get collection tree - PUT
/api/v2/\{team_slug\}/\{app_slug\}/collections/products- Upsert collections relationships - DELETE
/api/v2/\{team_slug\}/\{app_slug\}/collections/products- Delete collections relationships
Management Customer Groups
- PUT
/api/v1/\{team_slug\}/\{app_slug\}/customer-group-prices- Bulk upsert customer group product variant prices - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/customer-group-prices- Bulk delete customer group product variant prices - GET
/api/v1/\{team_slug\}/\{app_slug\}/customer-group-prices/\{customer_group_price_id\}- Get a customer group product variant price - GET
/api/v1/\{team_slug\}/\{app_slug\}/customer-groups- List all customer groups with pagination - POST
/api/v1/\{team_slug\}/\{app_slug\}/customer-groups- Create a customer group - GET
/api/v1/\{team_slug\}/\{app_slug\}/customer-groups/\{customer_group_id\}- Get a customer group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/customer-groups/\{customer_group_id\}- Update a customer group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/customer-groups/\{customer_group_id\}- Delete a customer group - GET
/api/v1/\{team_slug\}/\{app_slug\}/customer-groups/\{customer_group_id\}/prices- List customer group product variant prices
Custom Roles
- GET
/api/v1/\{team_slug\}/\{app_slug\}/custom-roles- List all custom roles within pagination - POST
/api/v1/\{team_slug\}/\{app_slug\}/custom-roles- Create a custom role - GET
/api/v1/\{team_slug\}/\{app_slug\}/custom-roles/\{custom_role_id\}- Get a custom role - PUT
/api/v1/\{team_slug\}/\{app_slug\}/custom-roles/\{custom_role_id\}- Update a custom role - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/custom-roles/\{custom_role_id\}- Delete a custom role
DAM Administration
- PUT
/api/v1/\{team_slug\}/\{app_slug\}/dam/files/\{file_id\}/folder- Set File Folder - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders- List DAM Folders (Flat View) - POST
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders- Create DAM Folder - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}- Get DAM Folder by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}- Delete DAM Folder - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}- Update DAM Folder - PUT
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}/items/bulk- Bulk Set Media Folder - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}/media- Get Folder Media - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}/roles- List Folder Roles - PUT
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}/roles/\{role_id\}- Add Role to Folder - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}/roles/\{role_id\}- Remove Role from Folder - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/\{folder_id\}/tree- Get Folder Tree from Path - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/folders/tree- Get DAM Folder Hierarchy Tree - PUT
/api/v1/\{team_slug\}/\{app_slug\}/dam/images/\{image_id\}/folder- Set Image Folder - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/media/search- Search DAM Media - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links- List all shareable links - POST
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links- Create a new shareable link - GET
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links/\{link_id\}- Get a specific shareable link - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links/\{link_id\}- Delete a shareable link - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links/\{link_id\}- Update a shareable link - POST
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links/\{link_id\}/resources- Add resources to a shareable link - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/dam/shareable-links/\{link_id\}/resources- Remove resources from a shareable link - PUT
/api/v1/\{team_slug\}/\{app_slug\}/dam/videos/\{video_id\}/folder- Set Video Folder
Files
- GET
/api/v1/\{team_slug\}/\{app_slug\}/files- List Files - PUT
/api/v1/\{team_slug\}/\{app_slug\}/files- Upload File - GET
/api/v1/\{team_slug\}/\{app_slug\}/files/\{file_id\}- Get File - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/files/\{file_id\}- Delete File - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/files/\{file_id\}- Update File - PUT
/api/v1/\{team_slug\}/\{app_slug\}/files/\{file_id\}/relationships/\{item_id\}- Add File Relationship - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/files/\{file_id\}/relationships/\{item_id\}- Delete File Relationship
Images
- GET
/api/v1/\{team_slug\}/\{app_slug\}/images- Retrieve all images - PUT
/api/v1/\{team_slug\}/\{app_slug\}/images- Upload image - GET
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}- Retrieve image - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}- Delete image - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}- Update image - PUT
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}/relationship- Create image relationship - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}/relationship- Delete image relationship - PUT
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}/relationships/bulk- Bulk Add Image Relationships - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}/relationships/bulk- Bulk Remove Image Relationships - POST
/api/v1/\{team_slug\}/\{app_slug\}/images/bulk- Bulk Upload Images - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/images/bulk- Bulk Delete Images - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/images/bulk- Bulk Patch Images
Logs
- GET
/api/v1/\{team_slug\}/\{app_slug\}/logs/\{item_id\}- Get Item Logs
Markets
- GET
/api/v1/\{team_slug\}/\{app_slug\}/markets- List all markets - POST
/api/v1/\{team_slug\}/\{app_slug\}/markets- Create a new market - GET
/api/v1/\{team_slug\}/\{app_slug\}/markets/\{market_slug\}- Get a market by slug - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/markets/\{market_slug\}- Delete a market - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/markets/\{market_slug\}- Update an existing market
Merchant Users
- GET
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users- List merchant users - POST
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users- Create merchant user - GET
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}- Get merchant user by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}- Delete merchant user - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}- Update merchant user - POST
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}/new-password- Set merchant user password - POST
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}/send-email-verification- Resend email verification - POST
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}/tags- Add tags to merchant user - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}/tags- Remove tags from merchant user
Orders
- GET
/api/v1/\{team_slug\}/\{app_slug\}/orders- List all orders - POST
/api/v1/\{team_slug\}/\{app_slug\}/orders- Create order - GET
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}- Get order by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}- Cancel order - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}- Update order - GET
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/history- Get order history - GET
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/lines- Get order lines - POST
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/lines- Create order line - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/lines/\{line_id\}- Delete order line - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/lines/\{line_id\}- Update order line - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/orders/\{order_id\}/status- Update order status - GET
/api/v1/\{team_slug\}/\{app_slug\}/orders/merchant-user/\{user_id\}- List orders by merchant user - GET
/api/v1/\{team_slug\}/\{app_slug\}/orders/metrics- Get sales metrics
Organizations
- GET
/api/v1/\{team_slug\}/\{app_slug\}/organisations- List all organizations - POST
/api/v1/\{team_slug\}/\{app_slug\}/organisations- Create a new organization - GET
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}- Get organization by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}- Delete an organization - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}- Update an existing organization - POST
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/address/\{address_id\}- Add address restriction for user - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/address/\{address_id\}- Remove address restriction for user - POST
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/tags- Add tags to organization - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/tags- Remove tags from organization - GET
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/tree- Get organization tree by ID - PUT
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/user- Add user to organization - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/user- Remove user from organization
Price Relay Rules
- POST
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-connections- Connect a source rule to a target rule - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-connections/\{connection_id\}- Disconnect a source rule from a target rule - GET
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules- List price relay source rules with pagination - POST
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules- Create a price relay source rule - GET
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules/\{rule_id\}- Get a price relay source rule including its connected target rules - PUT
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules/\{rule_id\}- Update a price relay source rule - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules/\{rule_id\}- Delete a price relay source rule (cascades its connections) - GET
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-target-rules- List price relay target rules with pagination - POST
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-target-rules- Create a price relay target rule - GET
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-target-rules/\{rule_id\}- Get a price relay target rule including its connected source rules - PUT
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-target-rules/\{rule_id\}- Update a price relay target rule - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/price-relay-target-rules/\{rule_id\}- Delete a price relay target rule (cascades its connections)
Product Bundle Groups
- GET
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups- List Bundle Groups - POST
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups- Create Bundle Group - GET
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}- Get Bundle Group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}- Delete Bundle Group - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}- Update Bundle Group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/markets/\{market_slug\}- Add Market to Bundle Group (Deprecated) - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/markets/\{market_slug\}- Remove Market from Bundle Group (Deprecated) - PUT
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/store-groups/\{store_group\}/markets/\{market_slug\}- Add Store Group Market to Bundle Group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/store-groups/\{store_group\}/markets/\{market_slug\}- Remove Store Group Market from Bundle Group
Product Bundles
- POST
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles- Create product bundle - GET
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}- Get product bundle - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}- Delete product bundle - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/bundle-groups/\{bundle_group_id\}/bundles/\{bundle_id\}- Update product bundle
Product Drafts
- GET
/api/v1/\{team_slug\}/\{app_slug\}/drafts- List Product Drafts - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft- Get Product Draft - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft- Create Product Draft - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft- Delete Product Draft - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft- Update Product Draft - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft/promote- Promote Product Draft
Products
- GET
/api/v1/\{team_slug\}/\{app_slug\}/products- List products - POST
/api/v1/\{team_slug\}/\{app_slug\}/products- Create a product - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}- Get a product by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}- Delete a product - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}- Update a product - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/categories- List Product Categories - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/categories/\{category_id\}- Add Product to Category - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/categories/\{category_id\}- Remove Product from Category - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/collections- Add collections to a product - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/collections- Remove collections from a product - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/collections/\{collection_id\}- Add a collection to a product - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/duplicate- Duplicate a product - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/images- Retrieve product images - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/images- Upload product image - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/images/\{image_id\}- Delete product image - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/soft-delete- Soft delete a product - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/tags/\{tag_key\}- Add a tag to a product - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/tags/\{tag_key\}- Remove a tag from a product - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/bulk- Bulk create products - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/bulk- Bulk delete products - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/bulk- Bulk update products - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/bulk/soft-delete- Bulk soft delete products - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/sku/\{product_number\}- Get a product by product number
Redirects
- GET
/api/v1/\{team_slug\}/\{app_slug\}/redirects- List all app redirects - POST
/api/v1/\{team_slug\}/\{app_slug\}/redirects- Create a new redirect - GET
/api/v1/\{team_slug\}/\{app_slug\}/redirects/\{redirect_id\}- Get redirect by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/redirects/\{redirect_id\}- Delete a redirect - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/redirects/\{redirect_id\}- Update a redirect - GET
/api/v1/\{team_slug\}/\{app_slug\}/redirects/item/\{item_id\}- List redirects for an item - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/redirects/item/\{item_id\}- Delete all redirects for an item
Relations
- GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/relations- List all relations for a product - GET
/api/v1/\{team_slug\}/\{app_slug\}/relations- List all relations in an app - POST
/api/v1/\{team_slug\}/\{app_slug\}/relations- Create a product relation - GET
/api/v1/\{team_slug\}/\{app_slug\}/relations/\{relation_id\}- Get a product relation - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/relations/\{relation_id\}- Delete a product relation - PUT
/api/v1/\{team_slug\}/\{app_slug\}/relations/\{relation_id\}/\{product_id\}- Add a product to a relation - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/relations/\{relation_id\}/\{product_id\}- Remove a product from a relation - GET
/api/v1/\{team_slug\}/\{app_slug\}/relations/types- List all relation types in an app - POST
/api/v1/\{team_slug\}/\{app_slug\}/relations/types- Create a relation type - GET
/api/v1/\{team_slug\}/\{app_slug\}/relations/types/\{type_id\}- Get a relation type - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/relations/types/\{type_id\}- Delete a relation type - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/relations/types/\{type_id\}- Update a relation type
Scheduling
- GET
/api/v1/\{team_slug\}/\{app_slug\}/schedule- List Scheduled Jobs - POST
/api/v1/\{team_slug\}/\{app_slug\}/schedule- Create Scheduled Job - GET
/api/v1/\{team_slug\}/\{app_slug\}/schedule/\{item_id\}- Get Item Scheduled Jobs - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/schedule/\{job_id\}- Delete Scheduled Job - POST
/api/v1/\{team_slug\}/\{app_slug\}/schedule/bulk- Bulk Create Scheduled Jobs - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/schedule/bulk- Bulk Delete Scheduled Jobs - GET
/api/v1/\{team_slug\}/\{app_slug\}/schedule/groups- List Scheduled Job Groups - POST
/api/v1/\{team_slug\}/\{app_slug\}/schedule/groups- Create Scheduled Job Group - GET
/api/v1/\{team_slug\}/\{app_slug\}/schedule/groups/\{group_id\}- Get Scheduled Job Group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/schedule/groups/\{group_id\}- Delete Scheduled Job Group
Smart Listings
- GET
/api/v1/\{team_slug\}/\{app_slug\}/smart-listings- List all smart listings - POST
/api/v1/\{team_slug\}/\{app_slug\}/smart-listings- Create a smart listing - GET
/api/v1/\{team_slug\}/\{app_slug\}/smart-listings/\{listing_id\}- Get a smart listing - PUT
/api/v1/\{team_slug\}/\{app_slug\}/smart-listings/\{listing_id\}- Update a smart listing - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/smart-listings/\{listing_id\}- Delete a smart listing - POST
/api/v1/\{team_slug\}/\{app_slug\}/smart-listings/preview- Preview smart listing results
Static Listings
- GET
/api/v1/\{team_slug\}/\{app_slug\}/static-listings- Get all static listings - POST
/api/v1/\{team_slug\}/\{app_slug\}/static-listings- Create a static listing - GET
/api/v1/\{team_slug\}/\{app_slug\}/static-listings/\{listing_id\}- Get a static listing - PUT
/api/v1/\{team_slug\}/\{app_slug\}/static-listings/\{listing_id\}- Update a static listing - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/static-listings/\{listing_id\}- Delete a static listing
Store Groups
- GET
/api/v1/\{team_slug\}/\{app_slug\}/store-groups- List all store groups - POST
/api/v1/\{team_slug\}/\{app_slug\}/store-groups- Create a store group - GET
/api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}- Get a store group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}- Delete a store group - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}- Update a store group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}/market/\{market_slug\}- Add a market to a store group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}/market/\{market_slug\}- Remove a market from a store group
Tags
- PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/tags/bulk- Bulk Add Products to Tags - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/tags/bulk- Bulk Remove Products from Tags - GET
/api/v1/\{team_slug\}/\{app_slug\}/tags- List all tags - POST
/api/v1/\{team_slug\}/\{app_slug\}/tags- Create a new tag - GET
/api/v1/\{team_slug\}/\{app_slug\}/tags/\{tag_key\}- Get a tag by key - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/tags/\{tag_key\}- Delete a tag - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/tags/\{tag_key\}- Update a tag - PUT
/api/v1/\{team_slug\}/\{app_slug\}/tags/\{tag_key\}/markets/\{market_slug\}- Associate tag with market - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/tags/\{tag_key\}/markets/\{market_slug\}- Remove tag from market - GET
/api/v1/\{team_slug\}/\{app_slug\}/tags/\{tag_key\}/products- List products by tag - POST
/api/v1/\{team_slug\}/\{app_slug\}/tags/bulk- Bulk Create Tags - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/tags/bulk- Bulk Delete Tags - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/tags/bulk- Bulk Update Tags - PUT
/api/v1/\{team_slug\}/\{app_slug\}/variants/tags/bulk- Bulk Add Variants to Tags - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/variants/tags/bulk- Bulk Remove Variants from Tags
Tax Groups
- GET
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups- List all tax groups - POST
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups- Create a tax group - GET
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups/\{tax_group_slug\}- Get a tax group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups/\{tax_group_slug\}- Delete a tax group - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups/\{tax_group_slug\}- Update a tax group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups/\{tax_group_slug\}/market/\{market_slug\}- Add a market to a tax group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/tax-groups/\{tax_group_slug\}/market/\{market_slug\}- Remove a market from a tax group
Third Party Link
- GET
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links- List all third-party links - POST
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links- Create a new third-party link - GET
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}- Get a third-party link - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}- Delete a third-party link - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}- Update a third-party link - PUT
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}/relationships/\{item_id\}- Link a third-party link to a product - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/third-party-links/\{third_party_link_id\}/relationships/\{item_id\}- Unlink a third-party link from a product
Translations
- GET
/api/v1/\{team_slug\}/\{app_slug\}/translations- List all translations - POST
/api/v1/\{team_slug\}/\{app_slug\}/translations- Create translation - GET
/api/v1/\{team_slug\}/\{app_slug\}/translations/\{translation_id\}- Get translation by ID - PUT
/api/v1/\{team_slug\}/\{app_slug\}/translations/\{translation_id\}- Update translation - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/translations/\{translation_id\}- Delete translation by ID - PUT
/api/v1/\{team_slug\}/\{app_slug\}/translations/bulk- Bulk update translations - POST
/api/v1/\{team_slug\}/\{app_slug\}/translations/bulk- Bulk create translations - GET
/api/v1/\{team_slug\}/\{app_slug\}/translations/ref/\{parent_ref\}- List translations by parent reference
Variant Groups
- PATCH
/api/v1/\{team_slug\}/\{app_slug\}/channels/\{channel_id\}/variant-groups/\{variant_group_id\}/status- Set variant group channel status - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups- List variant groups - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups- Create a variant group - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}- Get a variant group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}- Delete a variant group - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}- Update a variant group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}/images- Set variant group images - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}/images/reorder- Reorder variant group images - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}/tags/\{tag_key\}- Add a tag to a variant group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}/tags/\{tag_key\}- Remove a tag from a variant group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/\{group_id\}/videos- Set variant group videos - GET
/api/v1/\{team_slug\}/\{app_slug\}/variant-groups- List all app variant groups - POST
/api/v1/\{team_slug\}/\{app_slug\}/variant-groups/tags/bulk- Bulk Add Variant Groups to Tags - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/variant-groups/tags/bulk- Bulk Remove Variant Groups from Tags
Variant Templates
- GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/templates- Get product variant templates - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/templates- Set product variant templates - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/templates- Delete product variant templates
Variants
- GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants- List product variants - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants- Create product variant - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}- Get product variant - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}- Delete product variant - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}- Update product variant - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices- List variant prices by store group - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices- Create or update variant price - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices-batch- Batch create or update variant prices - GET
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices/\{store_group_slug\}- Get variant prices for store group - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices/\{store_group_slug\}/\{market_slug\}- Delete variant price - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/shipping-attributes- Upsert shipping attributes for a variant - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock- Set variant warehouse stock - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock/\{warehouse_slug\}- Delete variant warehouse stock - POST
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/stock/\{warehouse_slug\}/diff- Adjust variant stock by delta - PUT
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/tags/\{tag_key\}- Associate tag with variant - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/tags/\{tag_key\}- Remove tag from variant - GET
/api/v1/\{team_slug\}/\{app_slug\}/variants- List all app variants - POST
/api/v1/\{team_slug\}/\{app_slug\}/variants/bulk- Bulk create product variants - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/variants/bulk- Bulk delete product variants - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/variants/bulk- Bulk update product variants - PUT
/api/v1/\{team_slug\}/\{app_slug\}/variants/prices/bulk- Bulk create or update variant prices - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/variants/prices/bulk- Bulk delete variant prices - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/variants/prices/bulk- Bulk update variant prices - PUT
/api/v1/\{team_slug\}/\{app_slug\}/variants/stock/bulk- Set Stock for Multiple Variants - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/variants/stock/bulk- Delete Stock for Multiple Variants
Videos
- GET
/api/v1/\{team_slug\}/\{app_slug\}/videos- List videos - PUT
/api/v1/\{team_slug\}/\{app_slug\}/videos- Generate video upload URL - GET
/api/v1/\{team_slug\}/\{app_slug\}/videos/\{video_id\}- Get video by ID - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/videos/\{video_id\}- Delete video - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/videos/\{video_id\}- Update video - PUT
/api/v1/\{team_slug\}/\{app_slug\}/videos/\{video_id\}/relationship- Create video-to-item relationship - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/videos/\{video_id\}/relationship- Delete video-to-item relationship - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/videos/bulk- Bulk delete videos - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/videos/bulk- Bulk update videos
Warehouses
- GET
/api/v1/\{team_slug\}/\{app_slug\}/warehouses- List all warehouses - POST
/api/v1/\{team_slug\}/\{app_slug\}/warehouses- Create a new warehouse - GET
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\}- Get a warehouse - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\}- Delete a warehouse - PATCH
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\}- Update a warehouse - PUT
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\}/market/\{market_slug\}- Add a market to a warehouse - DELETE
/api/v1/\{team_slug\}/\{app_slug\}/warehouses/\{warehouse_slug\}/market/\{market_slug\}- Remove a market from a warehouse