Product API endpoints
| API Name | Method and URL | For Retailers | For Marketplaces | Details |
|---|---|---|---|---|
| List Products | GET /v2/retailer/$retailerCode/products/list Filter parameters: max=NUM (number of products to fetch at once, maximum 100) offset=NUM (retrieve the next set of products, starting at N from the beginning) sort=STRING (sort the returned product set by a product field, e.g. 'id') order=asc|desc (sort in ascending or descending order of sort field) active=true|false (if false, retrieve list of inactive products, defaults to true) |
Yes | No | Retrieve retailer's products |
| List Marketplace Products | GET /v2/retailer/$retailerCode/marketplace/$marketplaceCode/products/list Filter parameters: max=NUM (number of products to fetch at once, maximum 100) offset=NUM (retrieve the next set of products, starting at N from the beginning) sort=STRING (sort the returned product set by a product field, e.g. 'id') order=asc|desc (sort in ascending or descending order of sort field) sku=STRING (only return the product referenced by SKU) error=STRING (filter all products with a listing error of ERROR) |
Yes | Yes | Retrieves products prepared for the Marketplace |
| List Inventory | GET /v2/retailer/$retailerCode/inventory/list Filter parameters: max=NUM (number of products to fetch at once, maximum 100) offset=NUM (retrieve the next set of products, starting at N from the beginning) sort=STRING (sort the returned product set by a product field, e.g. 'id') order=asc|desc (sort in ascending or descending order of sort field) active=true|false (if false, retrieve list of inactive products, defaults to true) |
Yes | No | Retrieve inventory for retailer's products |
| List Marketplace Inventory | GET /v2/retailer/$retailerCode/marketplace/$marketplaceCode/inventory/list Filter parameters: max=NUM (number of products to fetch at once, maximum 100) offset=NUM (retrieve the next set of products, starting at N from the beginning) sort=STRING(sort the returned product set by a product field, e.g. 'id') order=asc|desc (sort in ascending or descending order of sort field) sku=STRING (only return the product referenced by SKU) error=STRING (filter all products with a listing error of ERROR) |
Yes | Yes | Retrieves inventory for products prepared for the Marketplace |
| Create Product | POST to /v2/retailer/$retailerCode/product/create |
Yes | No | Create a retailer product |
| Update Product | POST to /v2/retailer/$retailerCode/product/update |
Yes | No | Update an existing retailer product |
| Bulk Update Products | POST to /v2/retailer/$retailerCode/products/bulkUpdate |
Yes | No | Update a small set of retailer products (num products < 100) |
| Bulk Update Inventory | POST to /v2/retailer/$retailerCode/inventory/bulkUpdate |
Yes | No | Update only the quantity and optionally the price of product variants (num products < 100) |
Order API endpoints
| API Name | Method and URL | For Retailers | For Marketplaces | Details |
|---|---|---|---|---|
| List Orders | GET /v2/retailer/$retailerCode/orders/list Filter parameters: order_number=STRING (retrieve only the specified order) status=STRING (retrieve all orders in the specified lifecycle status, e.g. 'pending-shipped') created_before=DATE (only retrieve orders created before the specified date, in the format yyyy-MM-dd, e.g. 2020-01-31) created_after=DATE (only retrieve orders created after the specified date, in the format yyyy-MM-dd, e.g. 2020-01-31) max=NUM (number of products to fetch at once, maximum 100) offset=NUM (retrieve the next set of products, starting at N from the beginning) sort=STRING (sort the returned product set by a product field, e.g. 'id') order=asc|desc (sort in ascending or descending order of sort field) |
Yes | No | Retrieve orders for all marketplaces |
| List Marketplace Orders | GET /v2/retailer/$retailerCode/marketplace/$marketplaceCode/orders/list Filter parameters: order_number=STRING (retrieve only the specified order) status=STRING (retrieve all orders in the specified lifecycle status, e.g. 'pending-shipped') created_before=DATE (only retrieve orders created before the specified date, in the format yyyy-MM-dd, e.g. 2020-01-31) created_after=DATE (only retrieve orders created after the specified date, in the format yyyy-MM-dd, e.g. 2020-01-31) max=NUM (number of products to fetch at once, maximum 100) offset=NUM (retrieve the next set of products, starting at N from the beginning) sort=STRING (sort the returned product set by a product field, e.g. 'id') order=asc|desc (sort in ascending or descending order of sort field) |
Yes | Yes | Retrieve orders for the Marketplace |
| View Marketplace Order | GET /v2/retailer/$retailerCode/marketplace/$marketplaceCode/order/view |
Yes | Yes | View order data |
| Create Marketplace Order | POST to /v2/retailer/$retailerCode/marketplace/$marketplaceCode/order/create |
Yes | Yes | Create an Order for the given Marketplace. |
| Update Marketplace Order | POST to /v2/retailer/$retailerCode/marketplace/$marketplaceCode/order/update |
Yes | Yes | Update order data |
| Webhook | POST to /v2/retailer/$retailerCode/marketplace/$marketplaceCode/order/webhook |
Yes | Yes | TODO |
Order Lifecycle Graph
