Get Returns

get

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

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 return orders for the specified filter criteria. The same API can be used to search a single order based on returnOrderId/ customerOrderId This API supports only upto an offset of 1000 in response with max limit 100 orders. If you want to fetch more than 1000 then you can use the cursor API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

returnCreationStartDate

string

Defaults to NOW-180DAYS

Start Date for querying all return orders after that date. Either both the returnCreationStartDate, returnCreationEndDate must be present in the query params or none present. Use URI encoded time format.

returnCreationEndDate

string

Defaults to NOW

End Date for querying all return orders after that date. Either both the returnCreationStartDate, returnCreationEndDate must be present in the query params or none present. Use URI encoded time format.

limit

string

Defaults to 10

The number of orders to be returned. Cannot be greater than 100.

offset

string

Defaults to 0

The starting offset of the first order required in the response. Cannot be greater than 1000

customerOrderId

string

The customer order ID.

returnOrderId

string

The return order ID.

statusCodeFilter

string

The status code filter to apply. Valid values will be Initiated, Completed and Cancelled.

isWFSEnabled

string

Flag to get WFS returns. Valid value is Y

Headers

WM_MARKET

string

enum

Allowed:

WM_SEC.ACCESS_TOKEN

string

required

The access token retrieved in the Token API call

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

Responses

Language

URL

Loading…

Response

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

application/json

200Successful Operation

400Failure Operation

500Failure Operation 500