Get Customer Return Orders status

get https://marketplace.walmartapis.com/v3/fulfillment/return-orders

The API provides the list of customer return orders with corresponding details.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

limit

string

Limiting the number of records fetched. Valid range is from 1 to 50 inclusive.

offset

string

Setting an offset to skip records. Valid range is from 0 to 50000 inclusive.

orderNo

string

Search the order based on an order number.

returnOrderNo

string

Search the order based on a return order number.

fromOrderDate

string

Search the order based on a start date (Date in YYYY-MM-DD format).

toOrderDate

string

Search the order based on an endDate date (Date in YYYY-MM-DD format).

Headers

Authorization

string

required

Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.

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

Response

Response body

object

header

object

Header for the response

headerAttributes

object

Header attributes for returns.

payload

array of objects

Order details

payload

object

returnOrderId

string

The return order id.

sellerOrderId

string

The seller order id.

returnOrderLines

array of objects

The return order lines.

returnOrderLines

object

lineNo

string

Line number

sellerOrderId

string

Seller order id

returnReason

string

Reason for return

returnReasonDesc

string

Reason description

itemDetail

object

Item detail

qty

object

Quantity for the line

lineQuantityInfo

array of objects

Line quantity information

lineQuantityInfo

object

status

string

Status of the line

statusCode

int32

Status code of the line

statusDescription

string

Description of the status

statusQuantity

object

Quantity for the line

imageURL

string

Image URL

faultCategory

string

Fault category

inspectionComments

string

Inspection comments

dispositionCode

object

Disposition code

currentTrackingStatuses

array of objects

Current tracking statuses

currentTrackingStatuses

object

trackingStatus

string

Status of tracking

quantity

object

Quantity for the line

currentTrackingStatusTime

date-time

Current tracking status time

returnLineGroups

array of objects

The return line groups.

returnLineGroups

object

groupNo

string

The group no.

returnOrderGroupLines

array of objects

The return order group lines.

returnOrderGroupLines

object

lineNo

string

Unique identifier for the line

qty

object

Quantity for the line

labelImageUrl

string

The label image url.

carrierInfo

object

The carrier info.

shipFrom

object

The ship to address.

shipTo

object

The ship to address.

channelName

string

The channel name.

status

string

Status of the response

OK CREATED ACCEPTED CANCELLED NO_CONTENT PARTIAL MOVED_PERMANENT FOUND SEE_OTHER NOT_MODIFIED TEMPORARY_REDIRECT BAD_REQUEST UNAUTHORIZED FORBIDDEN NOT_FOUND METHOD_NOT_ALLOWED NOT_ACCEPTABLE REQUEST_TIMEOUT CONFLICT REQUEST_ENTITY_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_ENTITY TOO_MANY_REQUESTS PARTIAL_SUCCESS FAIL BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT SUCCESS

errors

array of objects

Errors for the response

errors

object

code

string

required

field

string

description

string

info

string

severity

string

INFO WARN ERROR

200Successful Operation