Download Label (New)

Use this API to download the labels of booked shipments.

Currently, download label API enables the download of carrier labels for small parcel
shipments. After submitting a label generation request, you can call the Download Label
API. If the label request is still being processed, the response will return a status of 202
(Accepted). Once the labels are ready, the API response will include a PDF file containing the labels.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique identifier identifying each shipment.

string
required

labelType.

string
required

Size options available to choose from through the labelSize.

Headers
string
required

Use a Basic Authorization header by Base64-encoding the Client ID and Client Secret obtained in step two of the integration process. Format the credentials as ClientID:ClientSecret before encoding.

string
required

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

string

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

string
required

A unique identifier that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.

string
required

Specifies the name of the Walmart service being called.

string
enum
required

GLOBAL VERSION DEFAULT AS 3.1.

Allowed:
string
enum
required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default.

Allowed:
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf