Reference
API Reference
246 operations across 27 resources. Search or filter to find what you need, then open an endpoint for examples and an AI explainer.
Account
7 ops- get/accountGet Account
- get/account/purchase-order-strategyGet Account PO Strategy
- get/account/settingsGet Account Settings
- get/account/custom-aggregate-fieldsGet Custom Aggregate Fields
- get/settingsGet Settings
Channel
8 ops- post/channel/Create Channel
- get/channel/{id}Get Channel
- get/channels/{channelId}/settingsGet Channel Settings
- get/channel/Get Channels
- put/channel/{id}Put Channel
Connection
6 ops- post/connectionsCreate Connection
- get/connections/available-configsGet Available Connection Configs
- get/connections/{id}Get Connection
- get/connections/typesGet Connection Types
- get/connectionsGet Connections
Fulfillment Request
18 ops- patch/fulfillment-requests/{fulfillmentRequestId}/acknowledgeAcknowledge Fulfillment Request
- patch/fulfillment-requests/{fulfillmentRequestId}/committed-stockAdjust Applicable Committed Stock
- post/fulfillment-requests/{fulfillmentRequestId}/adjustAdjust Fulfillment Request
- patch/fulfillment-requests/{fulfillmentRequestId}/cancelCancel Fulfillment Request
- post/fulfillment-requests/{fulfillmentRequestId}/committed-stockCommit Stock For Fulfillment Request
Inbound Shipments
3 opsInventory
14 ops- post/inventory[Deprecated] Create/Update InventoryDeprecated
- get/inventory/variant/{variantId}/pair[Deprecated] Get Inventory PairDeprecated
- get/inventory/{parentId}/{variantId}[Deprecated] Get Inventory PairDeprecated
- get/inventory/{sourceId}/parent[Deprecated] Get Inventory ParentDeprecated
- get/inventory/{sourceId}/variant[Deprecated] Get Inventory VariantDeprecated
Listing
19 ops- get/listing/variants/{variantId}/pair[Deprecated] Get Listing PairDeprecated
- post/listing/search/parents[Deprecated] Search Listing ParentsDeprecated
- post/listing/search/variants[Deprecated] Search Listing VariantsDeprecated
- patch/listing/parentsAcknowledge Listing Parents
- patch/listing/variantsAcknowledge Listing Variants
Listing Builder
5 ops- post/listing/{channelId}/builder/build/{productVariantId}Build Listing from Product Variant
- get/listing/{channelId}/builder/countGet Listing Builder Count
- get/listing/builder/re-build/countGet Listing Rebuilder Count
- post/listing/{channelId}/builder/re-build/parent/{listingParentId}Rebuild Listing Parent
- post/listing/{channelId}/builder/re-build/variant/{listingVariantId}Rebuild Listing Variant
MappingSet
10 ops- post/mapping-set/{id}/itemAdd Item to Mapping Set
- post/mapping-setCreate Mapping Set
- delete/mapping-set/{id}/itemDelete Item from Mapping Set
- delete/mapping-set/{id}Delete Mapping Set
- get/mapping-set/{id}/convertGet Converted Value
MappingTemplate
5 opsOrder
12 ops- get/orders/{channelId}/{orderNumber}[Deprecated] Get Order by Order NumberDeprecated
- get/orders/list[Deprecated] List OrdersDeprecated
- post/checkoutCheckout Order
- post/ordersCreate Order
- post/orders/{orderId}/itemsCreate Order Item
Package
1 opProduct
19 ops- get/product/{parentId}/{variantId}[Deprecated] Get Product PairDeprecated
- get/product/variant/{variantId}/pair[Deprecated] Get Product Pair by Variant IDDeprecated
- get/product/products/variant[Deprecated] Get Product VariantDeprecated
- get/product/variant/inventorylinks[Deprecated] Get Product Variant Inventory LinksDeprecated
- post/product/search/variants[Deprecated] Search Product VariantsDeprecated
Product Builder
13 ops- put/product/builder/issues/{issueId}/buildBuild Product From Existing Issue
- post/product/builder/build/{inventoryVariantId}Build Product from Inventory Variant
- delete/product/builder/issues/{issueId}Delete Product Builder Issue
- delete/product/builder/issuesDelete Product Builder Issues
- get/product/builder/pending-countGet Product Builder Count
Purchase Order
15 ops- patch/purchase-orders/{purchaseOrderId}/acknowledge[Deprecated] Acknowledge Purchase OrderDeprecated
- patch/purchase-orders/{purchaseOrderId}/committed-stock[Deprecated] Adjust Applicable Committed StockDeprecated
- post/purchase-orders/{purchaseOrderId}/adjust[Deprecated] Adjust Purchase OrderDeprecated
- patch/purchase-orders/{purchaseOrderId}/cancel[Deprecated] Cancel Purchase OrderDeprecated
- post/purchase-orders/{purchaseOrderId}/committed-stock[Deprecated] Commit Stock For Purchase OrderDeprecated
Resellers
3 opsReturns
6 ops- post/returnsCreate Return
- get/returns/{id}Get Return by ID
- get/returnsGet Returns
- put/returns/{returnId}/sync-refundSync Return Refund to the Channel Invoice for the Order
- patch/returns/{id}Update Return
RMA
11 ops- put/rmas/{id}/sync-creditApply credit to a source invoice
- post/rmaCreate RMA
- post/rma-shipmentsCreate RMA Shipment
- get/rma/{id}Get Rma By ID
- get/rma-shipments/{id}Get RMA Shipment By ID
Routing
3 opsShipment
9 ops- post/shipmentsCreate Shipment
- delete/shipment/{id}/custom-fieldsDelete Shipment Custom Fields
- delete/shipment/{id}/shipment-itemDelete Shipment Item
- delete/shipment/{shipmentId}/shipment-item/{shipmentItemId}/custom-fieldsDelete Shipment Item Custom Fields
- put/shipments/flag-with-errorsFlag Shipments with Sync Errors
Shipping
16 ops- post/shipping/source-shipping-methodsAdd Source Shipping Method
- delete/shipping/channel-shipping-methods/bulkBulk Delete Channel Shipping Methods
- post/shipping/channel-shipping-methodsCreate Channel Shipping Method
- post/shipping/shipping-policyCreate Shipping Policy
- delete/shipping/channel-shipping-methods/{id}Delete Channel Shipping Method
Source
11 ops- post/sourcesCreate Source
- get/source/{id}Get Source
- get/source/{sourceId}/auto-create-products-and-listingsGet Source
- get/source/{sourceId}/business-hoursGet Source Business Hours
- get/sources/{sourceId}/purchase-order-strategyGet Source PO Strategy
Source Invoice
4 opsTags
4 opsVendor
5 opsWebhook
6 ops- post/webhhok/configurationsCreate Webhook Configuration
- get/webhhok/configurations/{id}Get Webhook
- get/webhook/configurations/{id}/event-logsGet Webhook Configuration Event Logs
- get/webhhok/configurationsList Webhook Configurations for an account
- post/webhook/event/retryRetry Webhook Event
Workflow
13 ops- put/workflow/{id}/copy-draft-to-liveCopy Draft Workflow To Live
- put/workflow/{id}/copy-live-to-draftCopy Live Workflow To Draft
- post/workflow/mapping-ruleCreate/Update Mapping Rule
- delete/workflow/{id}Delete Workflow
- delete/workflow/mapping-rule/{mappingRuleId}Delete Workflow Mapping Rule