Label details by purchase order ID
The Labels detail by purchase order ID API retrieves shipping label information on multiple orders such as label generation, carrier service type, shipment tracking, shipment protection, and signature protection.
Endpoint
GET https://marketplace.walmartapis.com/v3/shipping/labels/purchase-orders/{purchaseOrderId}Function
Key features of this API include:
- Order-specific label details: Retrieve shipping label data associated with a particular purchase order ID.
- Streamlined operations: Automate integration of shipping label information into your fulfillment workflow.
- Enhanced accuracy: Provides clear and structured label information to ensure shipments are processed and dispatched with fewer errors.
- Tracking details: Show the tracking information.
Request Sample
curl --request GET \ --url https://marketplace.walmartapis.com/v3/shipping/labels/purchase-orders/purchaseOrderId \ --header 'accept: application/json'Modify Your Code
Replace purchaseOrderId in the request URL with the actual Walmart purchase order ID you want to query. Keep the accept header as application/json so the API returns the label details in JSON format.
Response Sample
Request 200 Sample 1
{ "data": [ { "purchaseOrderId": "65108826634074798", "trackingNo": "14300153617516", "boxItems": [ { "sku": "06068906426236Test", "quantity": 1, "lineNumber": "1" } ], "carrierName": "FedEx", "carrierFullName": "FedEx", "carrierServiceType": "FedEx 2Day", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=14300153617516&locale=en_US&cntry_code=us" } ]
}Request 200 Sample 2
{ "data": [ { "purchaseOrderId": "65108826634074798", "trackingNo": "14300153617516", "boxItems": [ { "sku": "06068906426236Test", "quantity": 1, "lineNumber": "1" } ], "carrierName": "FedEx", "carrierFullName": "FedEx", "carrierServiceType": "FedEx 2Day", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=14300153617516&locale=en_US&cntry_code=us", "addOns": [ { "name": "INSURANCE", "charge": { "amount": 0.32, "currency": "USD" }, "declaredValue": { "amount": 40, "currency": "USD" }, "refLink": "https://docs.google.com/forms/d/e/1FAIpQLSfptruFTsLSkL2T3xi50m3BZn6xFHApbliZqucpIxSYqVXEvA/viewform?pli=1", "status": "Active" }, { "name": "SIGNATURE", "charge": { "amount": 6.35, "currency": "USD" }, "status": "Active" } ] } ]
}Result
A successful response returns a data array with the label details for the purchase order. The response can include the purchase order ID, tracking number, shipped item lines, carrier name, service type, tracking URL, and add-on details when they exist.
Next Steps
The Create label API lets you buy labels from Walmart to ship orders.
The Shipping estimates API provides the best rate to ship an order.
The Supported carriers API provides a list of Walmart's approved carriers to ship orders.
The Download label API retrieves a carrier label by the carrier and tracking number.
The Discard label API removes shipping labels.
The Supported carrier package types API provides package types the carrier offers.
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.
The Download scan form API downloads a scan form document from the manifestId.
The Get ship-on-date API provides recommendations for the default ship-on-date and maximum ship-on-date on seller orders.
Updated about 1 month ago