Get Returns

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

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.

string
Defaults to 10

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

string
Defaults to 0

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

string

The customer order ID.

string

The return order ID.

string

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

string

Flag to get WFS returns. Valid value is Y

Headers
string
enum
Allowed:
string
required

The access token retrieved in the Token API call

string

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

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
required

Walmart Service Name

Responses

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