Create label

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

Create a shipping label for items.

The response to a successful call is in JSON, PDF, or image format, based on the media type specified in the Accept header.

For example:

Accept: application/pdf returns a PDF response.
Accept: image/png returns an image response.
Accept: application/json returns a JSON response.

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

required

Authorization

string

Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.

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

Supported Media Type : application/json, application/pdf, image/png

Responses

Language

URL


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

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

application/json

application/pdf

image/png

200Successful Operation

400Failure Operation

500Internal Server Error