Retrieve all orders

get

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

This request retrieves all open purchase orders and purchase orders closed and canceled within the last 30 days and their relevant details.

Use the appropriate query parameters to filter the purchase orders in the returned list.
All query parameters are optional.

Calls to this endpoint return 50 purchase orders by default.
You can specify a minimum of 1 order and a maximum of 100 orders per API call.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

purchaseOrderID

string

Walmart-issued unique identifier of the purchase order.

hostPurchaseOrderId

string

Unique identifier of the host purchase order that created this purchase order.

type

string

enum

Walmart-issued purchase order code that identifies the purchase order type.

Valid values include, but are not limited to:

Value	Meaning
3	GENERAL DISTRIBUTION
7	GENERAL SHIP BILL
20	REBUY REGULAR
22	REBUY SEASONAL
33	ASSEMBLY DISTRIBUTION
37	ASSEMBLY SHIP AND BILL
40	IMPORT REBUY REGULAR
42	IMPORT REBUY SEASONAL
43	IMPORT DISTRIBUTION
53	TAB DISTRIBUTION
73	STORE REPLN DISTRIBUTION
77	FITSPRO

purchaseOrderStatus

string

enum

Status of the purchase order.

Valid values are:

Value	Meaning
ACTIVE	Status of a newly created purchase order that has not yet been fulfilled. Suppliers can request edits to purchase orders when in active status.
CANCELLED	Status of the purchase order that is no longer in progress, but none of the purchase order lines have been fulfilled by the supplier.
CLOSED	Status of the purchase order that is no longer in progress and the lines in the purchase order have been fulfilled.
SPLIT_IMPORT	Indicates the import order was split up into smaller orders.

Allowed:

purchaseOrderSupplyChainStatus

string

Status of the purchase order in the supply chain.

Valid values for domestic and distribution center purchase orders are:

Value	Meaning
CANCELLED	Indicates the order was cancelled.
CLOSED	Indicates the order was closed.
OPEN	Indicates the order was opened.
RECEIVED	Indicates the order was received.

Valid values for import purchase orders are:

Value	Meaning
AT_PORT	Indicates the order is at a port.
CANCELLED	Indicates the order was cancelled.
CLOSED	Indicates the order was closed.
GATED_IN	Indicates a container has been unloaded from a ship and moved to an internal storage space in the distribution center (DC). In the DC, containers are initially stored in an external storage space (gated out) and later moved to an internal storage space (gated in).
RECEIVED	Indicates the order was received.
SAILING_MESSAGE	Indicates the cargo is sailing on the ship.

createdAfter

string

Returns purchase orders created after the specified date and time.

createdBefore

string

Returns purchase orders created before the specified date and time.

mustArriveByDateAfter

string

Returns purchase orders that must arrive after the specified date and time.

mustArriveByDateBefore

string

Returns purchase orders that must arrive before the specified date and time.

limit

string

Limits the number of returned results. Valid values are 1-100.

nextCursor

string

Indicates a value that allows users to retrieve the next set of records in the query response.

nextCursor is the preferred pagination mechanism for this API.

Headers

WM_CONSUMER.CHANNEL.TYPE

string

Identifier that tracks the consumer request by channel.

Use the consumer channel type provided by Walmart during your onboarding.
See your system administrator or developer management for the WM_CONSUMER.CHANNEL.TYPE value.

WM_QOS.CORRELATION_ID

string

required

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

wm_sec.access_token

string

required

Access token returned by the Create access token request.

Required for token-based authentication.

Responses

204

No data. No Content. The Purchase Order ID does not exist or no access exists.

400

Bad payload conditions.

Validation errors createdAfter date earlier than createdBefore results
Validation errors Limit cannot be greater than 100
Validation errors Invalid purchase order status
Validation errors type must be a number
Validation errors hostPurchaseOrderId must be a number
Validation errors Invalid purchase order Supply chain status

500

Internal Server Error.

200Successful operation