Supported carrier package type
Market availability: Global
The Supported carrier package types API are the package types a carrier offers.
Endpoint
GET /v3/shipping/labels/carriers/{carrierShortName}/package-typesFunction
- Package type compatibility: Verifies which package types (e.g., flat rate box, padded envelope) are compatible with Walmart shipping carriers.
- Usage: Helps you select the correct package type for shipping orders, minimizing shipping errors.
- Supported carriers: Provides carrier-specific information, meaning that it shows combinations (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/jsonheader. - 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 typePackageTypeShortName: Code used in API requestspackageTypeDisplayName: Human-readable name- Dimensions (
length,width,height) anddimensionUnit
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.
The Shipping estimates API provides the cheapest rate to ship an order.
The Labels detail by purchase order ID API retrieves shipping label information for orders, label generation, formatting, and tracking information for shipping as well as order management.
The Supported carriers API gives you a list of approved Walmart carriers to ship orders.
The Download label API brings up the carrier label when searching by carrier and tracking number.
The Discard label API removes shipping labels.
The Create label with multi-package API creates shipping labels for orders with multiple packages.
The Create scan form for labels API groups multiple labels so the carrier can scan a single document at pickup.
The Download scan form API downloads the scan form for a document.
Refer to the Walmart Claims Guide on how to get protection for your shipments.
Updated 8 days ago

