All orders

get

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

Retrieves the details of all the orders for a specified search criteria.

Market availability: Global

Query Params

productInfo

boolean

Provides the image URL and product weight in response, if available. Allowed values are true or false.
Market availability: Global

serviceInfo

boolean

serviceInfo.
Market availability: US only

shipNode

string

shipNode.
Market availability: US only

customerOrderId

string

customerOrderId.
Market availability: Global

purchaseOrderId

string

The purchase order ID. One customer may have multiple purchase orders.
Market availability: Global

status

array of strings

Status of purchase order line. Valid statuses are: Created, Acknowledged, Shipped, Delivered and Cancelled.
Market availability: US | CA | CL

status

condition

array of strings

condition.
Market availability: US only

condition

createdStartDate

string

Returns purchase orders created after the specified date and time.

Date Format : ISO 8601 date or datetime format.

Timezone : UTC

Examples:
1. 2025-05-30 (interpreted as 2020-03-16T00:00:00Z)
2. 2025-05-30T10:30:15Z

Notes:
When a date without time is provided, it defaults to midnight UTC.
Use the Z suffix to indicate UTC (Z=Zulu time=UTC).
Market availability: Global

createdEndDate

string

Returns purchase orders created before the specified date and time.

Date Format : ISO 8601 date or datetime format.

Timezone : UTC

Examples:
1. 2025-05-30 (interpreted as 2020-03-16T00:00:00Z)
2. 2025-05-30T10:30:15Z

Notes:
When a date without time is provided, it defaults to midnight UTC.
Use the Z suffix to indicate UTC (Z=Zulu time=UTC).
Market availability: Global

fromExpectedShipDate

string

Returns purchase orders that have orderlines with an expected ship date after this date.

Date Format : ISO 8601 date or datetime format.

Timezone : UTC

Examples:
1. 2025-05-30 (interpreted as 2020-03-16T00:00:00Z)
2. 2025-05-30T10:30:15Z

Notes:
When a date without time is provided, it defaults to midnight UTC.
Use the Z suffix to indicate UTC (Z=Zulu time=UTC).
Market availability: Global

toExpectedShipDate

string

Returns purchase orders that have orderlines with an expected ship date before this date.

Date Format : ISO 8601 date or datetime format.

Timezone : UTC

Examples:
1. 2025-05-30 (interpreted as 2020-03-16T00:00:00Z)
2. 2025-05-30T10:30:15Z

Notes:
When a date without time is provided, it defaults to midnight UTC.
Use the Z suffix to indicate UTC (Z=Zulu time=UTC).
Market availability: Global

lastModifiedStartDate

string

Fetches all purchase orders that were modified after this date. Use either UTC or ISO 8601 formats. Date example: '2020-03-16'(yyyy-MM-dd). Date with Timestamp example: '2020-03-16T10:30:15Z'(yyyy-MM-dd'T'HH:mm:ssZ).
Market availability: US | CA

lastModifiedEndDate

string

Fetches all purchase orders that were modified before this date. Use either UTC or ISO 8601 formats. Date example: '2020-03-16'(yyyy-MM-dd). Date with Timestamp example: '2020-03-16T10:30:15Z'(yyyy-MM-dd'T'HH:mm:ssZ).
Market availability: US | CA

shipNodeType

enum

Specifies the type of shipNode.
Market availability: Global

shippingProgramType

string

Specifies the type of program. Allowed value is TWO_DAY, ONE_DAY.
Market availability: US only

sku

string

A seller-provided Product ID.
Market availability: US | CA | CL

orderType

string

Specifies if the order is a regular order , replacement order or preorder. Possible values are REGULAR, REPLACEMENT or PREORDER. The REGULAR or REPLACEMENT will be provided in response only if query parameter replacementInfo=true.
Market availability: US only

replacementInfo

boolean

Defaults to false

Provides additional attributes - originalCustomerOrderID, orderType - related to Replacement order, in response, if available. Allowed values are true or false.
Market availability: US only

sortBy

string

enum

Field to sort the orders by orderDate and estimated ship date.
Market availability: CA

Allowed:

sortOrder

string

enum

Specifies the sort direction. Use desc for descending order and asc for ascending order.
Market availability: CA

Allowed:

limit

int32

Defaults to 0

The number of orders to be returned. Cannot be larger than 200 for US , CA | CL and Cannot be larger than 100 for MX.
Market availability: Global

facility

string

facility.
Market availability: US only

statusCodeFilter

array of strings

The status code filter to apply. Valid values will be Created, Acknowledged, Shipped, Cancelled, OnHold, Delivered.
Market availability: MX

statusCodeFilter

cursor

string

cursor.
Market availability: Global

Headers

WM_MARKET

string

enum

required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default.
Market availability: Global

Allowed:

WM_GLOBAL_VERSION

string

enum

required

Indicates the global version of the API. The value must be set to 3.1.
Market availability: Global

Allowed:

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_SANDBOX

string

enum

Include this header to access the Marketplace dynamic sandbox environment.
Market availability: US only

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful Operation

400Bad request. Invalid input or missing required parameters.

401Unauthorized. Authentication credentials are missing or invalid.

403Forbidden. The caller does not have the required permissions.

404Not found. The requested resource does not exist.

429Too many requests

500Internal server error. An unexpected error occurred.