Create label

post

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

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Label fields

packageType

string

required

Package Type. Supported Package Types are - 'CUSTOM_PACKAGE'

boxDimensions

object

required

Box Dimensions

boxItems

array of objects

required

Box Items

boxItems*

fromAddress

object

required

From Address

purchaseOrderId

string

required

Purchase Order Id

carrierName

string

required

Carrier Name. For now, the only supported carrier is - 'MailAmericas'

carrierServiceType

string

required

Carrier Service Type. For now, supported values are - 'US_CL_MAIL_AMERICAS', 'CN_CL_MAIL_AMERICAS'

shippingMethod

string

required

Carrier shipping method, For now, supported values are - 'STANDARD'

savePreset

boolean

required

save this set of shipping package for next time usage

labelSize

string

required

Carrier label size. For now, supported values are - 'LETTER_SIZE', 'A4', 'A6', 'A8' for MailAmericas

Headers

WM_MARKET

string

enum

required

Allowed:

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

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful Operation

400Failure Operation

500Internal Server Error