Note
The Fulfillment APIs are coming soon.
Fulfillment API Resources¶
Overview¶
This page lists all resources for the Fulfillment APIs. For the Shipping and Accounts APIs, click here instead. For the OAuth resource, see Generate an OAuth Token.
For the base URLs for the Fulfillment APIs, see API Environments. For a comparison of the current APIs with the legacy APIs, see Legacy API Map.
Products¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/products |
|
PUT |
/v1/products/{sku} |
|
POST |
/v1/products/bulk |
|
GET |
/v1/products/{sku} |
|
POST |
/v1/products/search |
ASN (Advanced Shipment Notification)¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/receiving-asn |
|
PUT |
/v1/receiving-asn/{receivingASNId} |
|
GET |
/v1/receiving-asn/{receivingASNId} |
|
POST |
/v1/receiving-asn/search
|
|
PUT |
/v1/receiving-asn/{receivingASNId}/cancel |
Inventory¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/inventory/snapshot |
Orders¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/orders |
|
PUT |
/v1/orders/{orderId} |
|
POST |
/v1/orders/bulk |
|
PUT |
/v1/orders/{orderId}/order-items |
|
GET |
/v1/orders/{orderId} |
|
GET |
/v1/orders/{orderId}/status |
|
POST |
/v1/orders/search
|
|
PUT |
/v1/orders/{orderId}/cancel |
|
PUT |
/v1/orders/bulk/cancel |
|
POST |
/v1/shipments/search |
Kits: Bill of Materials (BOM)¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/bill-of-materials |
|
PUT |
/v1/bill-of-materials/{bill-of-material-id} |
|
GET |
/v1/bill-of-materials/{bill-of-material-id} |
Kits: Work Orders¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/work-orders |
|
PUT |
/v1/work-orders/{work-order-id} |
|
GET |
/v1/work-orders/{work-order-id} |
|
POST |
/v1/work-orders/search
|
|
PUT |
/v1/work-orders/{work-order-id}/cancel |
Fulfillment Return Orders¶
API Operation |
Method |
Resource Path |
---|---|---|
POST |
/v1/returns |
|
PUT |
/v1/returns/{return-order-id} |
|
POST |
/v1/returns/bulk |
|
GET |
/v1/returns/{return-order-id} |
|
POST |
/v1/returns/search |