Create label

post

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

Create shipping label for items. The response to a successful call are of json or pdf type based on the media type passed in Accept header.
For eg. 'Accept'='application/json,application/pdf' will result in pdf media type and
'Accept'='application/json' as json response.

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', 'FEDEX_ENVELOPE', 'FEDEX_PAK'

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, supported carriers is - 'FedEx'

carrierServiceType

string

Carrier Service Type. For now, supported values for FedEx are - 'FEDEX_INTERNATIONAL_PRIORITY' for fedExPak/fedExEnvelope package types, 'FEDEX_INTERNATIONAL_ECONOMY' and 'FEDEX_INTERNATIONAL_GROUND'.

labelSize

string

Label Size e.g. A6, LETTER_SIZE or A4 for PDF response

Headers

WM.TEST_MODE

boolean

Defaults to false

For sellers/clients who are in the process of on boarding or already on boarded to IMD platforms, this feature allows them to test the API integration to SWW international label generation API. Sellers get a response which maps their request attributes with some additional static information like tracking and label. The label returned is corresponding to the carrier configured for each seller, in case if the configuration is still in progress a sample Fedex Express label is returned.

WM_CONSUMER.CHANNEL.TYPE

string

required

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

WM_SEC.TIMESTAMP

string

required

The Epoch timestamp

WM_SEC.AUTH_SIGNATURE

string

required

The vendor's digital signature, generated by running the JAR file or custom generation code

WM_CONSUMER.ID

string

required

A unique ID required to access the API

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200Successful Operation