Simulate a return

post

https://sandbox.walmartapis.com/v1/simulations/returns

Simulates return creation for a given customer order and line item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

purchaseOrderId

string

required

Purchase order identifier for the order being used in the return simulation.

lineNumber

integer

required

Line number of the item within the order to return.

qty

integer

required

Quantity of units being returned for the specified order line.

returnReason

string

enum

required

Reason for initiating the return.

Headers

WM_SANDBOX

string

enum

required

Include this header to access the Marketplace dynamic sandbox environment.

Allowed:

WM_SEC.ACCESS_TOKEN

string

required

The access token retrieved in the Token API call.

WM_SVC.NAME

string

required

Specifies the name of the Walmart service being called.

WM_SVC.VERSION

string

required

Service Version to access the API based on the version.

Responses

Language

Loading…

Response

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

application/json

200Return simulation successful

400Bad request

401Unauthorized

500Internal server error