--- updatedAt: 2026-06-22T19:19:50.000Z --- # Label details by purchase order ID This API retrieves all label details generated for a purchase order ID. [block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Ship With Walmart", "version": "1.0", "description": "The Ship With Walmart (SWW) APIs enables walmart.com sellers to buy shipping at competitively discounted rates directly from Walmart to ship their goods to US customers." }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" }, { "url": "https://sandbox.walmartapis.com", "description": "Sandbox URL" } ], "security": [ { "accessToken": [] } ], "paths": { "/v3/shipping/labels/purchase-orders/{purchaseOrderId}": { "get": { "tags": [ "Ship With Walmart" ], "summary": "Label details by purchase order ID", "description": "This API retrieves all label details generated for a purchase order ID.", "operationId": "getLabel", "x-stability": "beta", "security": [ { "accessToken": [] } ], "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "purchaseOrderId", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "WM_SEC.ACCESS_TOKEN", "description": "Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.\n\nMarket availability: Global", "required": true, "schema": { "type": "string" }, "example": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM....." }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "description": "A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "WM_QOS.CORRELATION_ID", "description": "A unique ID which identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.", "required": true, "schema": { "type": "string" }, "example": "b3261d2d-028a-4ef7-8602-633c23200af6" }, { "in": "header", "name": "WM_SVC.NAME", "description": "Walmart Service Name", "required": true, "schema": { "type": "string" }, "example": "Walmart Service Name" }, { "in": "header", "name": "Accept", "description": "The only supported response media type is application/json.", "required": true, "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "List of label details generated for the specified purchase order ID.", "items": { "type": "object", "properties": { "purchaseOrderId": { "type": "string", "description": "Purchase Order Id " }, "trackingNo": { "type": "string", "description": "Tracking Number" }, "boxItems": { "type": "array", "description": "Box Items", "items": { "required": [ "lineNumber", "quantity", "sku" ], "type": "object", "properties": { "sku": { "type": "string", "description": "sku of an item" }, "quantity": { "type": "integer", "description": "Quantity of Item", "format": "int32" }, "lineNumber": { "type": "string", "description": "PO Line Number" }, "productName": { "type": "string", "description": "Name of the Product. This is a mandatory field if carrier is opted as 'Yanwen' and also for India(IN) to United-States(US) shipping" }, "productNameInLocale": { "type": "string", "description": "Name of the Product in Mandarin. This is a mandatory field if carrier is opted as 'Yanwen'" }, "hsCode": { "type": "string", "description": "HS Code. This is a mandatory field for India(IN) to United-States(US) shipping" }, "originState": { "type": "string", "description": "Origin State. This is a mandatory field for India(IN) to United-States(US) shipping" }, "originCity": { "type": "string", "description": "Origin City. This is a mandatory field for India(IN) to United-States(US) shipping" }, "countryOfOrigin": { "type": "string", "description": "Country of Origin. This is a mandatory field for India(IN) to United-States(US) shipping" } }, "description": "Box Items" } }, "carrierName": { "type": "string", "description": "Carrier Short Name" }, "carrierFullName": { "type": "string", "description": "Carrier Full Name" }, "carrierServiceType": { "type": "string", "description": "Carrier Service Type" }, "trackingUrl": { "type": "string", "description": "Tracking URL" }, "addOns": { "type": "array", "description": "Add Ons Response", "items": { "required": [ "charge", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the AddOn type.", "enum": [ "SIGNATURE", "INSURANCE" ] }, "charge": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount" }, "currency": { "type": "string", "description": "Currency", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] } }, "description": "Charge of add-on type." }, "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount" }, "currency": { "type": "string", "description": "Currency", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] } }, "description": "Declared value of shipment. This value is applicable in case of INSURANCE add-on type only." }, "refLink": { "type": "string", "description": "Reference link for the add-on type." }, "status": { "type": "string", "description": "Status of the add-on type." } }, "description": "List of add-ons returned for the estimate." } } }, "description": "Label and tracking details of shipment in the purchase order." } }, "errors": { "type": "array", "description": "List of error details describing why the request failed.", "items": { "type": "object", "properties": { "info": { "type": "string", "description": "Additional contextual information about the error." }, "code": { "type": "string", "description": "Error code identifying the failure reason." }, "field": { "type": "string", "description": "Name of the request field that triggered this error, when applicable." }, "description": { "type": "string", "description": "Human-readable description of the error." }, "severity": { "type": "string", "description": "Severity level of the error.", "enum": [ "EMERG", "ALERT", "CRITICAL", "ERROR", "WARN" ] }, "category": { "type": "string", "description": "Category classifying the origin of the error.", "enum": [ "APPLICATION", "SERVICE", "REQUEST", "DATA" ] }, "httpStatus": { "type": "integer", "description": "HTTP status code associated with this error.", "format": "int32" } }, "description": "Error detail object." } } } }, "examples": { "sample1": { "value": { "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" } ] } }, "sample2": { "value": { "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" } ] } ] } } } } } } } } } }, "components": { "securitySchemes": { "accessToken": { "type": "apiKey", "in": "header", "name": "WM_SEC.ACCESS_TOKEN", "description": "Access token from POST /v3/token (client_credentials grant)." } } } } ```