Ship order lines

post

https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}/shipping

Updates the status of order lines to Shipped and triggers the charge to the customer. A successful response contains the order with the shipped line items.

Market availability: Global

CBT/OOC note (US only): For US sellers enrolled in the Cross Border Trade/Out Of Country program, Walmart will automatically generate a Ship With Walmart shipping label whenever the endpoint is called. If the label generation fails (due to issues such as carrier API failure, Hazmat ineligibility, or the dimensions exceed carrier limits) then a 400 Bad Request or 500 Internal Server Error will be returned. If this occurs, submit a third-party tracking number instead. Refer to the Ship an order (US) API for full error details.

Path Params

purchaseOrderId

string

required

purchaseOrderId.
Market availability: Global

Body Params

orderShipment

object

Headers

WM_SEC.ACCESS_TOKEN

string

required

Access token from POST /v3/token (client_credentials grant).
Market availability: Global

WM_SVC.NAME

string

required

Walmart Service Name.
Market availability: Global

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_MARKET

string

enum

required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default.
Market availability: Global

Allowed:

WM_GLOBAL_VERSION

string

enum

required

Indicates the global version of the API. The value must be set to 3.1.
Market availability: Global

Allowed:

WM_SANDBOX

string

enum

Include this header to access the Marketplace dynamic sandbox environment.
Market availability: US only

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

application/problem+json

200Successful Operation

400Bad request. This is due to an invalid input, a required parameter is missing, or an ineligible Cross Border Trade (CBT) shipment cannot be retried.

401Unauthorized. Authentication credentials are missing or invalid.

403Forbidden. The caller does not have the required permissions.

404Not found. The requested resource does not exist.

429Too many requests

500Internal server error. An unexpected error occurred. For Cross Border Trade enrolled orders, this indicates label generation failure. Submit a third-party tracking number if the error persists.