docs
Search or ask...
back to main menu
Getting Started
Introduction
Authentication & Authorization
SDK set up
General
Migration
Errors
Nested Resources
Pagination
Rate Limits
Versioning
Identifiers
Resources
Assets
Upload an asset
Attribute groups
Get attribute groups for given filters
Create a new attribute group
Get an attribute group
Update an existing attribute group
Delete an attribute group
Update frontend name for an existing attribute group
Get attributes for given attribute group.
Create an unattached attribute for the given attribute group.
Update the given attribute.
Delete an attribute
Attributes
Product attributes
Get product attributes
Update or create a product attribute
Get a product attribute
Delete a product attribute
Unlock a attribute group for a product.
Product variant attributes
Get product variant attributes
Update or create a product variant attribute
Get a product variant attribute
Delete a product variant attribute
Unlock a attribute group for a product variant.
Product master attributes
Get product master attributes
Update or create a product master attribute
Get a product master attribute
Delete a product master attribute.
Unlock a attribute group for a product master.
Product image attributes
Get product image attributes
Update or create a product image attribute
Get a product image attribute
Delete a product image attribute
Unlock a attribute group for a product image.
Attribute translations
Get attribute translations
Update or create simple attribute translations
Partially update or create simple attribute translations
Update, create or delete non-shared localized attribute translations
Brands
Get a brand
Update an existing brand
Delete a brand
Get brands for given filters
Create a new brand
Campaigns
Get campaigns for given filters
Create a new campaign
Get a campaign
Update an existing campaign
Delete a campaign
Get variant reduction for given campaign
Create or update campaign product variant reductions
Create or update campaign product reductions
Delete all or specific campaign reductions
Carriers
Get carriers for given filters
Create a new carrier
Get a carrier
Update an existing carrier
Attach a carrier to a merchant
Detach a carrier from a merchant
Companies
Get companies
Create a new company
Get a company
Update an existing company
Order channels
Get a list of order channels.
Create a new order channel.
Get an order channel.
Update an order channel.
Delete an order channel.
Custom data configuration
Get Custom Data Config
Update an existing custom data config
Create a new Custom Data Config
Delete custom data config
Customers
Get customers for given filters
Create a new customer
Get a customer
Delete a customer
Update an existing customer
Update customer reference key
Update custom data of the customer.
Set a password for a customer
Set a password hash for a customer
Anonymize a customer
Cancel the queued deletion of a customer
Reset customer password
Customer addresses
Get customer addresses
Create a new customer address
Get explicit customer address
Update a customer address
Update a customer address reference key
Anonymize a customer address
Anonymize a customer address
Customer groups
Create new customer groups
Delete customer group
Customer memberships
Get customer memberships
Create a new customer membership
Update an existing customer membership
Delete a customer membership
Customer states
Get a customer status
Update an existing customer status
Fulfilment
Create a new shipment
Send a cancellation
Return items
Hosting
Purge CDN cache for a hosting environment
Master categories
Get master categories for given filters
Create a new master category
Get master category by ID
Update an existing master category
Delete a master category
Merchants
Get merchants for given filters
Create a new merchant
Get a merchant
Update an existing merchant
Merchant contacts
Get contacts for given filters
Create a new contact
Get a contact
Update an existing contact
Delete a contact
Merchant return addresses
Get return addresses for given filters
Create a new return address
Get a return address
Update an existing return address
Delete a return address
Merchant warehouses
Get merchant warehouses for given filters
Attach a warehouse to a merchant
Detach a warehouse from a merchant
Orders
Get orders for given filters
Create an order
Create a subscription order
Get a order
Delete an order
Update order reference key
Update custom data of the order item
Update order billing status
Get an order status
Create or update order custom data
Trigger a manual capture
Order invoices
Get order invoices
Get an order invoice content
Order documents
Get order documents
Get order document content
Package groups
Get a collection of package groups assigned to given shop
Replace a package group for a list of shop warehouses
Assign a package group to a list of shop warehouses
Delete a package group
Products
Get products for given filters
Create a new shop product
Get a product
Update an existing product
Delete a product
Update state of an existing product
Update similar products of an existing product
Unlock product asset sortings
Copy an existing product
Create or update first live at for all the variants of a product.
Create a new bulk request.
Create, update and/or delete product sellable timeframes
Update product master categories
Product masters
Update the master categories of product master
Product compositions
Create a new bulk request.
Create a new shop composite product
Update an existing composite product
Delete a composite product
Product images
Get product images
Create a new product image
Delete a product image
Update a product image position
Product sets
Unlink referencing product sets
Product sortings
Create or update product sortings
Delete product sortings
Product variants
Get product variants
Create a new shop product variant
Get a product variant
Update an existing product variant
Delete a product variant
Product variant compositions
Create a new shop composite product variant
Update an existing composite product variant
Delete a composite product variant
Product variant prices
Get all product variant prices
Update or create a product variant price
Delete a product variant price
Create a new bulk request.
Price rounding
Get price roundings.
Create a new price rounding
Delete a price rounding
Promotions
Get promotions for given filters
Create a promotion
Get a promotion
Update an existing promotion
Delete a Promotion
Create a promotion
Update a promotion
Audiences
Get audiences for given filters
Create a new audience
Get an audience
Update an audience
Delete an audience
Customer segments
Get customer segments
Create a customer segment
Get a customer segment
Delete a customer segment
Update a customer segment
Promotion codes
Get promotions codes belonging to a specific promotion
Create promotion codes
Delete all or specific promotion Codes of a Promotion
Promotion item sets
Get promotion item sets for given filters
Create an item set for promotions
Get an promotion item set by id
Delete an item set of a promotion
Redirects
Get redirects based on the given filters.
Create a redirect.
create or update redirects
delete redirects
Update a redirect.
Delete a redirect.
Reservations
Create new reservations
Delete a reservation
Shops
Get shops for given filters
Create a new shop
Get a shop by key
Update an existing shop
Shop countries
Get shop countries for given filters
Create a new shop country
Get a shop country by code
Update an existing shop country
Assortments
Update a shop country assortment
Update a shop country assortment
Shop country warehouses
Attach a warehouse to a shop country
Update an existing shop country warehouse relation
Detach a warehouse from a shop country
Shop categories
Get shop categories for given filters
Create a new shop category
Get a shop category
Delete a shop category
Update an existing shop category
Get shop category country configuration
Create or update a shop category country configuration
Shop category properties
Get shop category properties
Update or create a shop category property
Get a shop category property
Delete a shop category property
Shop category property keys
Get shop category property keys
Create a new shop category property key
Get a shop category property key
Update an existing shop category property key
Delete a shop category property key
Stock
Get product variant stock information
Create new product variant stock information
Create a new bulk request.
Manage sellableWithoutStock for a given variant
Vouchers
Get a voucher
Delete a voucher
Update an existing voucher
Get vouchers for given filters
Create a new voucher
Voucher criteria
Get a voucher criterion
Update an existing voucher criterion
Delete a voucher criterion
Get voucher criteria
Add new criterion to the voucher
Warehouses
Get warehouses for given filters
Create a new warehouse
Delete a warehouse
Emails
Get email keys collection
Create a new email key
Send an email
Get an email key
Delete an email key
Update an email key
Custom data
Shop
Get custom data for a shop
Create or update custom data for a shop
Delete custom data for a shop
Get shop custom data for a specific key
Create or update shop custom data for a specific key
Delete shop custom data for a specific key
Shop countries
Get custom data for a shop country
Create or update custom data for a shop country
Delete custom data for a shop country
Get shop country data for a specific key
Create or update shop country custom data for a specific key
Delete a key of custom data for a shop country
Shop categories
Get custom data for a shop category
Create or update custom data for a shop category
Delete custom data for a shop category
Get data of a key in custom data for a shop category
Create or update a specific custom data key for a shop category
Delete custom data key for a shop category
Shop country categories
Get custom data for a shop category country
Create or update custom data for a shop category country
Delete custom data for a shop category country
Get data of custom data key for a shop category country
Create or update a specific custom data key for a shop category country
Delete custom data key for a shop category country
Products
Get custom data for a product
Create or update custom data for a product
Delete custom data for a product
Get data of a key in custom data for a product
Create or update specific key of custom data for a product
Delete a key of custom data for a product
Product variants
Get custom data for a product variant
Create or update custom data for a product variant
Delete custom data for a product variant
Get product variant custom data for a specific key
Create or update specific key of custom data of a product variant
Delete product variant custom data for a specific key
Product variant prices
Get custom data for a product variant price
Create or update custom data for a product variant price
Delete custom data for a product variant price
Get product variant price custom data for a specific key
Create or update a specific key of custom data for a product variant price
Delete product variant price custom data for a specific key
Product images
Get custom data for a product image
Create or update custom data for a product image
Delete custom data for a product image.
Get data of a key in custom data for a product image
Create or update specific key of custom data for a product image
Delete a key of custom data for a product image
Brands
Get custom data for a brand
Create or update custom data for a brand
Delete custom data for a brand
Get data of a key in custom data for a brand
Create or update specific key of custom data for a brand
Delete a key of custom data for a brand
Campaigns
Get custom data for a campaign
Create or update custom data for a campaign
Delete custom data for a campaign
Get campaign custom data for a specific key
Create or update specific key of custom data of a campaign
Delete campaign custom data for a specific key
Merchants
Get custom data for a merchant
Create or update custom data for a merchant
Delete custom data for a merchant.
Get data of a key in custom data for a merchant
Create or update specific key of custom data for a merchant
Delete a key of custom data for a merchant
Bulk requests
Get a list of bulk request statuses.
Get a bulk request status.
Cancel a bulk request.
Get a status of a bulk operation.
Webhooks V1
Return all available webhook events that are exposed by the system
Return all registered webhook subscriptions
Create a new webhook subscription
Return a registered webhook subscription
Delete an existing webhook subscription
Update a webhook subscription
Webhooks V2
List webhook events for a producer
List webhook subscriptions for a producer
Create a webhook subscription
Get a webhook subscription
Update a webhook subscription
Delete a webhook subscription
Merchants
Merchant Contacts
Update An Existing Contact
Update an existing contact
Last updated: September 03, 2026