Get all orders

get

https://marketplace.walmartapis.com/v3/ca/orders

Retrieves the details of all the orders for specified search criteria.
Value of nextCursor to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved.
For Ex: If the nextCursor value is ?limit=10&soIndex=2&poIndex=2&, then in order to get next set of records , call by appending the nextCursor value in request URL /v3/ca/orders?limit=10&soIndex=2&poIndex=2&.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sku

string

A seller-provided Product ID

customerOrderId

string

The customer order ID

purchaseOrderId

string

The purchase order ID. One customer may have multiple purchase orders.

status

string

Status may be specified to return orders of that type. Valid statuses are: Created, Acknowledged, Shipped, and Cancelled.

createdStartDate

string

required

Start Date for querying all purchase orders after that date. Use one of the following formats, based on UTC, ISO 8601. Date example: '2013-08-16' Timestamp example: '2013-08-16T10:30:15Z'

createdEndDate

string

Limits orders returned to those created before this createdEndDate. Two formats, based on ISO 8601, are allowed: UTC date or timestamp. Examples: '2016-08-16T10:30:30.155Z' or '2016-08-16'.

fromExpectedShipDate

string

Limits orders returned to those that have orderLines with an expected ship date after this fromExpectedShipDate. Format: YYYY-MM-DD

toExpectedShipDate

string

Limits orders returned to those that have orderLines with an expected ship date before this toExpectedShipDate. Format: YYYY-MM-DD

limit

string

The number of orders to be returned.Cannot be larger than 200.

productInfo

string

Provides the image URL and product weight in response, if available. This parameter must be boolean, e.g.: productInfo=true.

Headers

WM_CONSUMER.CHANNEL.TYPE

string

required

A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding

WM_QOS.CORRELATION_ID

string

required

A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID

WM_SVC.NAME

string

required

Walmart Service Name

WM_SEC.TIMESTAMP

string

required

The Epoch timestamp

WM_SEC.AUTH_SIGNATURE

string

required

The vendor's digital signature, generated by running the JAR file or custom generation code

WM_CONSUMER.ID

string

required

A unique ID required to access the API

Response

200Successful Operation