Create label

post

https://marketplace.walmartapis.com/v3/shipping/labels

This API generates shipping labels using the shipment information provided. A successful response includes a tracking number and a media type format (pdf or image) specified in the Accept header.
For example: 'Accept'='application/json,application/pdf' returns a pdf,
'Accept'='application/json,image/png' returns an image png and 'Accept'='application/json' returns a json response.

Refer request sample1 for United-States(US) to United-States(US) shipping.
Refer request sample2 for United-States(US) to United-States(US) shipping with addons.
Refer request sample3 for China(CN) to United-States(US) shipping.
Refer request sample4 for BYOA.

Note: The Ship with Walmart service from China to the U.S. is paused until further notice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Label fields

packageType

string

required

Package Type. This value maps to 'packageTypeShortName' from Supported carrier package types API response.

boxDimensions

object

required

Box dimensions and weight for a shipping package.

boxItems

array of objects

required

Box Items

boxItems*

fromAddress

object

From address

purchaseOrderId

string

required

Purchase order ID

carrierName

string

required

Carrier name. This value maps to 'shortName' from Supported carriers API response. Currently FedEx and USPS are supported carriers.

carrierServiceType

string

required

Carrier service type. This value maps to 'serviceTypes.name' from Shipping Estimates API response

addOns

array of strings

Add-on response items. Add-ons can be opted during label generation for a shipping. Supported values for Add-ons are INSURANCE and SIGNATURE. We support standard SIGNATURE Type for now.

addOns

Allowed:

returnAddress

object

Return Address. This is only mandatory field for yanwen.

hasBattery

boolean

hasBattery flag. Pass 'true' if the shipment consists of battery. This is a mandatory field for yanwen.

hazmat

boolean

hazmat flag. Pass 'true' if the shipment consists of hazardous material.

accountType

string

Account Type. This is a mandatory field in case of BYOA

shipOnDate

string

^\d{4}-\d{2}-\d{2}$

Optional. The ship-on date for the label in yyyy-MM-dd format. Use the Get ship-on-date API to retrieve the valid ship-on date window before creating a label.

Headers

WM_CONSUMER.CHANNEL.TYPE

string

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

WM_SEC.ACCESS_TOKEN

string

required

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

Market availability: Global

WM_QOS.CORRELATION_ID

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.

WM_SVC.NAME

string

required

Walmart Service Name

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200Successful Operation