Returns

get

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

Retrieve return orders that match the provided filters, including status, type, creation/last-modified date ranges, and paging. Optionally include replacement attributes. Use this endpoint to monitor RMA activity and reconcile refunds across your catalog.

If no filters are provided, the API returns all return orders for the seller, starting with the most recently created return orders.

For details see the Returns guide.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

returnOrderId

string

Return order identifier also known as RMA number. Use to filter results.

customerOrderId

string

Customer sales order identifier. Use to filter results.

status

string

Filter by return order status. Valid values are INITIATED, DELIVERED, COMPLETED.

replacementInfo

string

Include replacement return attributes in the response when true. Attributes include replacementCustomerOrderID, returnType, rechargeReason, and returnCancellationReason. Valid values are true or false.

returnType

string

Filter by return type. Valid values are PREORDER, REPLACEMENT, REFUND.

isWFSEnabled

string

enum

Filter Walmart Fulfillment Services (WFS) returns. Allowed values: Y (WFS only), N (non-WFS only). Omit to return all.

Allowed:

returnCreationStartDate

date-time

Return orders created on or after this date.

Accepts ISO 8601 date or date time. For example 2020-03-16 or 2020-03-16T10:30:15Z.

To pass a timezone offset in a query string, percent encode the plus sign. For example 2020-04-18T10:42:41.000%2B0000.

returnCreationEndDate

date-time

Return orders created on or before this date.

Accepts ISO 8601 date or date time. For example 2020-03-16 or 2020-03-16T10:30:15Z.

To pass a timezone offset in a query string, percent encode the plus sign. For example 2020-04-18T10:42:41.000%2B0000.

returnLastModifiedStartDate

date-time

Return orders modified on or after this date.

Accepts ISO 8601 date or date time. For example 2020-03-16 or 2020-03-16T10:30:15Z.

To pass a timezone offset in a query string, percent encode the plus sign. For example 2020-04-18T10:42:41.000%2B0000.

returnLastModifiedEndDate

date-time

Return orders modified on or before this date.

Accepts ISO 8601 date or date time. For example 2020-03-16 or 2020-03-16T10:30:15Z.

To pass a timezone offset in a query string, percent encode the plus sign. For example 2020-04-18T10:42:41.000%2B0000.

limit

string

Defaults to 10

Maximum number of return orders per response. Must not exceed 200.

Headers

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

WM_SANDBOX

string

enum

Include this header to access the Marketplace dynamic sandbox environment.

Allowed:

Response

200Successful Operation