Get all WFS orders

get

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

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerOrderId

string

The customer order ID

status

string

Status may be specified to return orders of that type. Valid statuses are: Created, Shipped and Cancelled.

createdStartDate

string

required

Start Date for querying all purchase orders after that date. Use one of the following formats, based on UTC, ISO 8601. Date example: '2013-08-16' Timestamp example: '2013-08-16T10:30:15Z'

createdEndDate

string

Limits orders returned to those created before this createdEndDate. Two formats, based on ISO 8601, are allowed: UTC date or timestamp. Examples: '2016-08-16T10:30:30.155Z' or '2016-08-16'.

limit

string

The number of orders to be returned.Cannot be larger than 200.

offset

string

Starting order offset for the current page

Headers

WM_CONSUMER.CHANNEL.TYPE

string

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

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_SVC.NAME

string

required

Walmart Service Name

WM_SEC.TIMESTAMP

string

required

The Epoch timestamp

WM_SEC.AUTH_SIGNATURE

string

required

The vendor's digital signature, generated by running the JAR file or custom generation code

WM_CONSUMER.ID

string

required

A unique ID required to access the API

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

200Successful Operation