Discard label

Marks a previously generated shipping label as discarded.
This API is used when the label should no longer be used for shipment processing.

Applicable Shipping Programs:
This API is supported for the following shipping programs: Walmart Provided Shipping (WPS) and Ship with Walmart (SWW).

Market availability: US | CA | MX

Path Params
string
required

The short name of the shipping carrier.
Use the carrierShortName value returned from the Supported Carriers API to ensure compatibility.

Market availability: US | CA | MX

string
required

The shipment tracking number.

Market availability: US | CA | MX

Headers
string
required

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

Market availability: Global

string

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

Market availability: Global

string
required

A unique ID that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.
Example: b3261d2d-028a-4ef7-8602-633c23200af6
Market availability: Global

string
required

Specifies the name of the Walmart service being called.
Example: Walmart Marketplace.

Market availability: Global

string
enum
required

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

Market availability: Global

Allowed:
string
enum
required

Indicates the global version of the API. The value must be set to 3.1.

Market availability: Global

Allowed:
Responses

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