API Reference
My Account

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
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:
string

A seller-provided Product ID.
Market availability: CA

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

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

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

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:
string

customerOrderId.
Market availability: CA | MX

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
string
required

The access token retrieved in the Token API call.
Market availability: Global

string
enum
required

WALMART MARKETS.
Market availability: Global

Allowed:
string
enum
required

GLOBAL VERSION DEFAULT AS 3.1.
Market availability: Global

Allowed:
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.
Market availability: Global

string
required

Specifies the name of the Walmart service being called.
Example: Walmart Service Name.
Market availability: Global

string

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago