Create label with Multi Package

Creates a shipping label for items, supporting multiple packages per request. A successful response includes a tracking number and a label file in the media type specified by the Accept header. This API supports all shipping programs, including Walmart Provided Shipping (WPS) and Ship with Walmart (SWW).

Media Type Options (via Accept header):
•application/json, application/pdf → Returns the label in PDF format.
•application/json → Returns tracking info only, in JSON format.

Market availability: CA | MX

Body Params

Label fields

packageDimensions
array of objects
required

Package Dimensions

packageDimensions*
boxItems
array of objects
required

Box Items, 1 total quantity supported for multiple packages

boxItems*
fromAddress
object
required

From address

string
required

Purchase order ID.
Applicable to SWW and WPS.

string
required

Carrier name. The only supported carrier is 'FedEx'.
Applicable to SWW only.

string
required

Carrier service type. Supported values are - 'FEDEX_INTERNATIONAL_PRIORITY' for single fedExPak/fedExEnvelope package types, 'FEDEX_INTERNATIONAL_ECONOMY' and 'FEDEX_INTERNATIONAL_GROUND'.
Applicable to SWW only.

Headers
string
required

Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.

Market availability: Global

string

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

Market availability: Global

string
required

A unique ID which identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.

Market availability: Global

string
required

Walmart Service Name

Market availability: Global

string
enum
required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default. Valid values: MX, CA, CL.

Market availability: Global

Allowed:
string
enum
required

Indicates the global version of the API. The value must be set to 3.1.

Market availability: Global

Allowed:
string
required

Response type. The order of media types in the Accept header determines the priority for response format selection.

Market availability: CA

Responses

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