Retailer API

The retailer APIs intended audience are partners that are listing and selling inventory. The following sections of this document cover each area that may be integrated to automate the entire fulfillment life cycle. Each section consists of a brief summary and a few use cases to demonstrate how the API could be used within your environment. Use cases are for demonstration purposes only, and are not intended to cover every possible error state.

Download our postman collection to see how the endpoints can be used.

Inventory – How to manage virtual inventory.

Use Case 1: Get new item(s) and acknowledge.

Use Case 2: Get availability and acknowledge.

Use Case 3: Using Notifications: Get recently updated items, acknowledge, and archive.

Orders – How to place and order and tracking status changes.

Use Case 1: Create order.

Use Case 2: Get shipments.

Use Case 3: Post message.

Use Case 4: Request cancellation.

Requests – How to create a new return and monitor for further action.

Use Case 1: Create new return.

Use Case 2: Monitor requests.

Use Case 3: Post message.

Use Case 3: Request cancellation.