Create label

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

time	status	user agent
Retrieving recent requests…

Loading…

This API generates shipping labels with the shipment info passed. The response to a successful call contains the tracking number with the pdf or image type based on the media type passed in Accept header. For example, 'Accept'='application/json,application/pdf' will result in pdf media type, 'Accept'='application/json,image/png' as image png media type and 'Accept'='application/json' as 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.

Body Params

Label fields

packageType

string

required

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

boxDimensions

object

required

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

AddOns Type. AddOns can be opted during label generation for a shipping. Supported values for AddOns are INSURANCE and SIGNATURE. We support standard SIGNATURE Type for now.

addOns

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

Headers

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

string

required

Only supported Media Type : application/json

Response

Language

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://marketplace.walmartapis.com/v3/shipping/labels \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "boxDimensions": {
8
    "boxWeightUnit": "LB"
9
  }
10
}
11
'

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

application/json

application/pdf

image/png

200Successful Operation