The Supported carrier package types API provides the different package types offered by a carrier.

Endpoint

GET https://marketplace.walmartapis.com/v3/shipping/labels/carriers/{carrierShortName}/package-types

Function

Key features of this API include:

• Package type compatibility: Verifies which package types are compatible with Walmart shipping carriers (for example, flat rate box, padded envelope).
• Usage: Helps you choose the correct package type to ship orders and minimize shipping errors.
• Supported carriers: Provides carrier-specific package type information, such as which carriers support specific packaging options (for example, FedEx supports padded envelopes packaging).

Request sample

curl --request GET \ --url https://marketplace.walmartapis.com/v3/shipping/labels/carriers/carrierShortName/package-types \ --header 'accept: application/json'

Modify your code

• Keep the accept: application/json header.
• Parse the response to extract package type details.

Response sample

{ "data": [ { "id": "DBF09762-C2B1-4D92-B159-41FC4C7BF3FD", "packageTypeShortName": "CUSTOM_PACKAGE", "packageTypeDisplayName": "Custom Package", "length": 0, "width": 0, "height": 0, "dimensionUnit": "IN" }, { "id": "A26CFAA3-D3F3-4647-9180-F344A7736996", "packageTypeShortName": "FEDEX_ENVELOPE", "packageTypeDisplayName": "FedEx Envelope", "length": 12.5, "width": 9.5, "height": 0, "dimensionUnit": "IN" }, { "id": "98120D70-7BCB-44BB-9912-F4655CC05A7D", "packageTypeShortName": "FEDEX_PAK", "packageTypeDisplayName": "FedEx Pak", "length": 12.75, "width": 10.25, "height": 0, "dimensionUnit": "IN" } ]
}

Result

Each package type includes:

• id: Unique identifier of the package type.
• packageTypeShortName: Code used for API requests.
• packageTypeDisplayName: The package display with a human-readable name.
• Dimensions (length, width, height) and dimensionUnit.

Your application can use this data to validate package selections and ensure compatibility with the carrier.

Next Steps

The Create label API lets you buy labels from Walmart to ship orders.

• Create label Guide
• Create label API Reference Guide

The Shipping estimates API provides the best rate to ship an order.

• Shipping estimates Guide
• Shipping estimates API Reference Guide

The Label details by purchase order ID API procures shipping label information on multiple orders such as label generation, carrier service type, shipment tracking, shipment protection, and signature protection.

• Label details by purchase order ID Guide
• Label details by purchase order ID API Reference Guide

The Supported carriers API provides a list of Walmart's approved carriers to ship orders.

• Supported carriers Guide
• Supported carriers API Reference Guide

The Download label API retrieves a carrier label by the carrier and tracking number.

• Download label Guide
• Download label API Reference Guide

The Discard label API removes shipping labels.

• Discard label Guide
• Discard label API Reference Guide

The Create scan form for labels API creates a scan form (also called a shipping manifest) to group multiple labels together for a carrier to scan a single document at pickup.

• Create scan form for labels Guide
• Create scan form for labels API Reference Guide

The Download scan form API downloads a scan form document from the manifestId.

• Download scan form Guide

• Download scan form API Reference Guide

The Get ship-on-date API provides recommendations for the default ship-on-date and maximum ship-on-date on seller orders.

• Get ship-on-date Guide
• Get ship-on-date API Reference Guide