Integration Instances
Create Integration Instance
Create a new integration instance.
Get Integration Instance
Get a single integration instance with its integration, store mappings, and warehouse location map.
Update Integration Instance
Update an integration instance. Settings are merged (not replaced) with existing settings.
Delete Integration Instance
Queue deletion of an integration instance. The actual deletion is handled asynchronously via the salesOrderProcessing queue.
List Listings (Sales Channel Products)
Get listings (sales channel products) for an integration instance.
Bulk Delete Listings
Bulk delete listings. Either ids or filters must be provided.
Get Single Listing
Lookup a listing document in the sales channel. For Amazon: searches by seller_sku. For Shopify: by variant_id, sku, or id. For others: by sku or _id.
Delete Single Listing
Delete a single listing from the integration instance.
Check Listing Deletability
Check whether listings can be deleted (i.e., are not linked to products).
Download Listings from Channel
Queue a download of listings (products) from the sales channel.
Get Listing Mapping Info
Get mapping statistics — how many listings are total and how many are mapped to SKU products.
Map Listing to SKU Product
Map one or more listings to SKU products.
Unmap Listing from SKU Product
Unmap listings from SKU products. Either ids or filters must be provided.
Create SKU Products from Listings
Create SKU products from listings using a field mapping. Either ids, filters, or initial_mapping must be provided.
Import Listing Mappings
Import listing mappings from a previously uploaded file. Dispatches an ImportListingMapping job.
List Sales Channel Orders
Get unlinked (orphan) sales channel orders for an integration instance.
Get Single Sales Channel Order
Get a single sales channel order with its linked SKU sales order.
Refresh Order from Sales Channel
Refresh a sales channel order with fresh data from the channel API (Shopify only).
Download Orders from Channel
Queue a download of orders from the sales channel.
Create SKU Orders from Channel Orders
Create SKU sales orders from unlinked sales channel orders. Either ids or filters required.
Bulk Archive Channel Orders
Bulk archive sales channel orders.
Bulk Unarchive Channel Orders
Bulk unarchive sales channel orders.
Archive Single Channel Order
Archive a single sales channel order.
Unarchive Single Channel Order
Unarchive a single sales channel order.
Preview Sync Inventory
Preview what inventory values would be synced to the sales channel before actually syncing.
Store Mapped Warehouse Locations
Save Shopify location to warehouse mappings for an integration instance.
Get Magento Stores
Get available stores from a Magento integration instance.
Get Magento Store Mappings
Get current store-to-sales-channel mappings for a Magento integration instance.
Map Magento Stores
Create or update Magento store to sales channel mappings.
Delete Magento Payment Method Mapping
Delete Magento payment method mapping.
Download Magento Orders
Trigger Magento order download.
Download Magento Products
Trigger Magento product download.
Download Magento Stores
Download stores from Magento API.