Retrieve all orders

get

https://api-gateway.walmart.com/v3/orders

This request retrieves details of all the orders for specified search criteria.

The search only retrieves orders created in last 180 days.

A maximum of 20,000 orders can be fetched at a time. Attempting to download more than 20,000 orders will return an error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

shipNode

string

required

Distribution facility distributor identifier.

This parameter identifies the facility from which the inventory is requested. Facility identifiers are autogenerated during account creation, when adding new facilities, and when updating existing facilities in Supplier Center. Take care to use the latest value for your desired facility.

limit

string

Specifies the number of orders to be returned. This value cannot be greater than 200.

sku

string

Specifies the stock keeping unit (SKU) item identifier.

This identifier is an arbitrary alphanumeric identifier specified by the DSV.

Special characters that require encoding include: :, /, ?, #, [, ], @, !, $, &, ', (, ), *, +, ,, ;, =, {, }, and %.

Encode spaces as %20.

customerOrderId

string

Customer purchase order identifier.

purchaseOrderId

string

Unique identifier associated of the purchase order.

status

string

Specifies the status of the purchase order line.

Valid values are:

Value	Meaning
Acknowledged	The purchase order line has been acknowledged.
Cancelled	The purchase order line has been cancelled.
Created	The purchase order line has been created.
Delivered	The purchase order line item has been delivered.
Shipped	The purchase order line item has been shipped.

createdStartDate

string

Starting date for the query date range.

This query fetches all purchase orders created after this date. The default is the current date minus seven days.

Use either the yyyy-MM-dd or yyyy-MM-dd'T'HH:mm:ssZ ISO 8601 format.

createdEndDate

string

Ending date for the query date range.

This query fetches all purchase orders created before this date. The default is the current date minus seven days.

Use either the yyyy-MM-dd or yyyy-MM-dd'T'HH:mm:ssZ ISO 8601 format.

fromExpectedShipDate

string

Starting expected ship date range for the query.

This query fetches all purchase orders that have order lines with an expected ship date after this date.

Use either the yyyy-MM-dd or yyyy-MM-dd'T'HH:mm:ssZ ISO 8601 format.

toExpectedShipDate

string

Ending expected ship date range for the query.

This query fetches all purchase orders that have order lines with an expected ship date before this date.

Use either the yyyy-MM-dd or yyyy-MM-dd'T'HH:mm:ssZ ISO 8601 format.

productInfo

string

Specifies whether or not to include the image URL and product weight in the response, if available.

If true, the image URL and product weight are provided in the response. If false, the image URL and product weight are not provided in the response.

The default value for this parameter is false.

Headers

WM_CONSUMER.CHANNEL.TYPE

string

Identifier that tracks the consumer request by channel.

Use the consumer channel type received during your onboarding. Contact your system administrator or developer management for the correct WM_CONSUMER.CHANNEL.TYPE value.

WM_QOS.CORRELATION_ID

string

required

Unique identifier for each API call, used to track and debug issues.

Use a randomly generated GUID for this ID.

WM_SEC.ACCESS_TOKEN

string

required

Access token returned by the Create access token request.

This value is required for token-based authentication.

Response

200Successful Operation