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

Create a Product

POST

/v1/products

Update a Product

PUT

/v1/products/{sku}

Create or Update Multiple Products

POST

/v1/products/bulk

View a Product

GET

/v1/products/{sku}

Find Products

POST

/v1/products/search

ASN (Advanced Shipment Notification)

API Operation


Method

Resource Path

Create an ASN

POST

/v1/receiving-asn

Update an ASN

PUT

/v1/receiving-asn/{receivingASNId}

View an ASN

GET

/v1/receiving-asn/{receivingASNId}

Find ASNs

POST

/v1/receiving-asn/search
/v1/receiving-asn/status/search

Cancel an ASN

PUT

/v1/receiving-asn/{receivingASNId}/cancel

Inventory

API Operation


Method

Resource Path

View an Inventory Snapshot

POST

/v1/inventory/snapshot

Orders

API Operation


Method

Resource Path

Create an Order

POST

/v1/orders

Update an Order

PUT

/v1/orders/{orderId}

Create or Update Multiple Orders

POST

/v1/orders/bulk

Change Existing Order Items

PUT

/v1/orders/{orderId}/order-items

View an Order

GET

/v1/orders/{orderId}

Get Order Status

GET

/v1/orders/{orderId}/status

Find Orders

POST

/v1/orders/search
/v1/orders/status/search

Cancel an Order

PUT

/v1/orders/{orderId}/cancel

Cancel a Bulk Order

PUT

/v1/orders/bulk/cancel

Find Shipment Details for Fulfilled Orders

POST

/v1/shipments/search

Kits: Bill of Materials (BOM)

API Operation


Method

Resource Path

Create a Bill of Materials

POST

/v1/bill-of-materials

Update a Bill of Materials

PUT

/v1/bill-of-materials/{bill-of-material-id}

View Bill of Materials

GET

/v1/bill-of-materials/{bill-of-material-id}

Kits: Work Orders

API Operation


Method

Resource Path

Create a Work Order

POST

/v1/work-orders

Update a Work Order

PUT

/v1/work-orders/{work-order-id}

View a Work Order

GET

/v1/work-orders/{work-order-id}

Find Work Orders

POST

/v1/work-orders/search
/v1/work-orders/status/search

Cancel a Work Order

PUT

/v1/work-orders/{work-order-id}/cancel

Fulfillment Return Orders

API Operation


Method

Resource Path

Create a Fulfillment Return Order

POST

/v1/returns

Update a Fulfillment Return Order

PUT

/v1/returns/{return-order-id}

Create Bulk Return Orders for Fulfillment

POST

/v1/returns/bulk

View a Fulfillment Return Order

GET

/v1/returns/{return-order-id}

Find Fulfillment Return Orders

POST

/v1/returns/search