All WFS orders

get

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

Use this API to retrieve all orders fulfilled by Walmart Fulfillment Services (WFS). By default, it returns all WFS orders. To fetch Walmart Remote Fulfillment (WRF) orders specifically, set the programType parameter to WRF.

Market availability: CA | MX

Query Params

programType

string

enum

Defaults to WFS

Filters the orders by fulfillment program type. Allowed Values :
WFS: Walmart Fulfillment Services (default)
WRF: Walmart Remote Fulfillment.
Note: This parameter is case-insensitive. For example, wfs, WFS, or WfS are all valid values.

Market availability: CA | MX

Allowed:

sku

string

A seller-provided Product ID.
Market availability: CA

createdStartDate

string

If not provided, the API returns purchase orders created in the last 30 days by default.
Use this parameter to fetch purchase orders created after the specified date.
Supports either UTC or ISO 8601 formats.
Date example: '2020-03-16' (yyyy-MM-dd)
Timestamp example: '2020-03-16T10:30:15Z' (yyyy-MM-dd'T'HH:mm:ssZ).
Market availability: CA | MX

createdEndDate

string

Fetches all purchase orders that were created before this date. Default is current 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: CA | MX

fromExpectedShipDate

string

Fetches all purchase orders that have order lines with an expected ship date 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: CA

toExpectedShipDate

string

Fetches all purchase orders that have order lines with an expected ship date 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: CA

status

array of strings

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

status

Allowed:

customerOrderId

string

customerOrderId.
Market availability: CA | MX

limit

int32

Defaults to 0

The number of orders to return. The maximum value is 200 for CA and 100 for MX.
Market availability: CA | MX

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

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.