--- updatedAt: 2026-06-22T19:19:50.000Z --- # Create label This API generates shipping labels using the shipment information provided. A successful response includes a tracking number and a media type format (pdf or image) specified in the Accept header. For example: 'Accept'='application/json,application/pdf' returns a pdf, 'Accept'='application/json,image/png' returns an image png and 'Accept'='application/json' returns a json response. * Refer request sample1 for United-States(US) to United-States(US) shipping. * Refer request sample2 for United-States(US) to United-States(US) shipping with addons. * Refer request sample3 for China(CN) to United-States(US) shipping. * Refer request sample4 for BYOA. **Note**: The Ship with Walmart service from China to the U.S. is paused until further notice. [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": { "post": { "tags": [ "Ship With Walmart" ], "summary": "Create label", "description": "This API generates shipping labels using the shipment information provided. A successful response includes a tracking number and a media type format (pdf or image) specified in the Accept header.\nFor example: 'Accept'='application/json,application/pdf' returns a pdf, \n'Accept'='application/json,image/png' returns an image png and 'Accept'='application/json' returns a json response. \n\n* Refer request sample1 for United-States(US) to United-States(US) shipping. \n* Refer request sample2 for United-States(US) to United-States(US) shipping with addons. \n* Refer request sample3 for China(CN) to United-States(US) shipping. \n* Refer request sample4 for BYOA.\n\n **Note**: The Ship with Walmart service from China to the U.S. is paused until further notice.\n", "operationId": "createLabel", "x-stability": "beta", "security": [ { "accessToken": [] } ], "parameters": [ { "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_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_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": "Specifies the desired response format. The order of media types determines the priority for format selection.\n\n**Supported values:**\n- `application/json` : Returns tracking information only (no label file).\n- `application/json, application/pdf` : Returns the label in PDF format.\n- `application/json, image/png` : Returns the label in PNG format.", "required": true, "schema": { "type": "string" }, "example": "application/json" } ], "requestBody": { "description": "Label fields", "content": { "application/json": { "schema": { "required": [ "boxDimensions", "boxItems", "carrierName", "carrierServiceType", "packageType", "purchaseOrderId" ], "type": "object", "properties": { "packageType": { "type": "string", "description": "Package Type. This value maps to 'packageTypeShortName' from Supported carrier package types API response." }, "boxDimensions": { "required": [ "boxWeight", "boxWeightUnit" ], "type": "object", "description": "Box dimensions and weight for a shipping package.", "properties": { "boxLength": { "minimum": 0, "type": "number", "description": "The length of the package. Required when packageType is CUSTOM_PACKAGE, not required for other standard package types (Example: FEDEX_ENVELOPE, FEDEX_PAK) where dimensions are predetermined by the carrier.The Unit is determined by boxDimensionUnit." }, "boxWidth": { "minimum": 0, "type": "number", "description": "The width of the package. Required when packageType is CUSTOM_PACKAGE, not required for other standard package types (Example: FEDEX_ENVELOPE, FEDEX_PAK) where dimensions are predetermined by the carrier.The Unit is determined by boxDimensionUnit." }, "boxHeight": { "minimum": 0, "type": "number", "description": "The height of the package. Required when packageType is CUSTOM_PACKAGE, not required for other standard package types (Example: FEDEX_ENVELOPE, FEDEX_PAK) where dimensions are predetermined by the carrier.The Unit is determined by boxDimensionUnit." }, "boxWeight": { "type": "number", "description": "The weight of the package. Required for all package types. The Unit is determined by boxWeightUnit." }, "boxDimensionUnit": { "type": "string", "description": "Unit of measurement for the package length, width, and height. Allowed values: IN (inches), FT (feet), CM (centimeters). Required when packageType is CUSTOM_PACKAGE, not required for other standard package types (Example: FEDEX_ENVELOPE, FEDEX_PAK) where dimensions are predetermined by the carrier.", "enum": [ "IN", "FT", "CM" ] }, "boxWeightUnit": { "type": "string", "description": "Unit of measurement for the package weight. Allowed values: LB (pounds), KG (kilograms), OZ (ounces).", "enum": [ "LB", "KG", "OZ" ] } } }, "boxItems": { "type": "array", "description": "Box Items", "items": { "required": [ "lineNumber", "quantity", "sku" ], "type": "object", "properties": { "sku": { "type": "string", "description": "The stock keeping unit of an item." }, "quantity": { "type": "integer", "description": "Quantity of the item.", "format": "int32" }, "lineNumber": { "type": "string", "description": "PO line number." }, "productName": { "type": "string", "description": "The name of the product. This parameter is required if carrier is opted as 'Yanwen' and also for shipping from India(IN) to United-States(US)." }, "productNameInLocale": { "type": "string", "description": "The name of the product in Mandarin. This parameter is required if carrier is opted as 'Yanwen'." }, "hsCode": { "type": "string", "description": "HS Code, Harmonized System code, is a six-digit numerical identifier used for classifying traded products worldwide. This is a mandatory field for India(IN) to United-States(US) shipping." }, "originState": { "type": "string", "description": "Origin state. This field is mandatory for shipments from India (IN) to the United States (US)." }, "originCity": { "type": "string", "description": "Origin city. This field is mandatory for shipments from India (IN) to the United States (US)." }, "countryOfOrigin": { "type": "string", "description": "Country of origin. This field is mandatory for shipments from India (IN) to the United States (US)." } }, "description": "Box Items" } }, "fromAddress": { "required": [ "addressLine1", "city", "contactName", "country", "phone", "postalCode", "state" ], "type": "object", "properties": { "contactName": { "type": "string", "description": "Contact name" }, "companyName": { "type": "string", "description": "Company name" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City of the from address location." }, "state": { "type": "string", "description": "State or province of the from address. Use the standard two-letter code where applicable (example, CA, TX)." }, "postalCode": { "type": "string", "description": "ZIP or postal code of the from address location." }, "country": { "type": "string", "description": "Country code of the from address location (example, US)." }, "phone": { "type": "string", "description": "Phone number associated with the from address location." }, "email": { "type": "string", "description": "Email address associated with the from address location." } }, "description": "From address" }, "purchaseOrderId": { "type": "string", "description": "Purchase order ID " }, "carrierName": { "type": "string", "description": "Carrier name. This value maps to 'shortName' from Supported carriers API response. Currently FedEx and USPS are supported carriers." }, "carrierServiceType": { "type": "string", "description": "Carrier service type. This value maps to 'serviceTypes.name' from Shipping Estimates API response" }, "addOns": { "type": "array", "description": "Add-on response items. Add-ons can be opted during label generation for a shipping. Supported values for Add-ons are INSURANCE and SIGNATURE. We support standard SIGNATURE Type for now.", "items": { "type": "string", "description": "Add-on type. Add-ons can be opted during label generation for a shipping. Supported values for add-ons are INSURANCE and SIGNATURE. We support standard SIGNATURE Type for now.", "enum": [ "SIGNATURE", "INSURANCE" ] } }, "returnAddress": { "required": [ "addressLine1", "city", "contactName", "country", "phone", "postalCode", "state" ], "type": "object", "properties": { "contactName": { "type": "string", "description": "Contact name" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City of the return address location." }, "state": { "type": "string", "description": "State or province of the return address. Use the standard two-letter code where applicable (example, CA, TX)." }, "postalCode": { "type": "string", "description": "ZIP or postal code of the return address location." }, "country": { "type": "string", "description": "Country code of the return address location (example, US)." }, "phone": { "type": "string", "description": "Phone number associated with the return address location." }, "email": { "type": "string", "description": "Email address associated with the return address location." }, "shipNode": { "type": "string", "description": "ship Node" } }, "description": "Return Address. This is only mandatory field for yanwen." }, "hasBattery": { "type": "boolean", "description": "hasBattery flag. Pass 'true' if the shipment consists of battery. This is a mandatory field for yanwen." }, "hazmat": { "type": "boolean", "description": "hazmat flag. Pass 'true' if the shipment consists of hazardous material." }, "accountType": { "type": "string", "description": "Account Type. This is a mandatory field in case of BYOA" }, "shipOnDate": { "type": "string", "description": "Optional. The ship-on date for the label in yyyy-MM-dd format. Use the [Get ship-on-date API](https://developer.walmart.com/api/us/mp/ship-with-walmart#operation/getShipOnDate) to retrieve the valid ship-on date window before creating a label.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "example": "2026-06-02" } } }, "examples": { "sample1": { "value": { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 13, "boxLength": 13, "boxWidth": 9, "boxHeight": 0 }, "boxItems": [ { "lineNumber": "1", "sku": "PRECISE3PGLASS9", "quantity": 1 } ], "fromAddress": { "contactName": "Test Seller", "companyName": "Test Company", "addressLine1": "Add1", "addressLine2": "Add2", "city": "Anchorage", "state": "AK", "postalCode": "99501", "country": "US", "phone": "12253", "email": "test@walmart.com" }, "purchaseOrderId": "97108719025934786", "carrierName": "FedEx", "carrierServiceType": "FEDEX_2_DAY", "hazmat": true } }, "sample2": { "value": { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 13, "boxLength": 13, "boxWidth": 9, "boxHeight": 0 }, "boxItems": [ { "lineNumber": "1", "sku": "PRECISE3PGLASS9", "quantity": 1 } ], "fromAddress": { "contactName": "Test Seller", "companyName": "Test Company", "addressLine1": "Add1", "addressLine2": "Add2", "city": "Anchorage", "state": "AK", "postalCode": "99501", "country": "US", "phone": "12253", "email": "test@walmart.com" }, "addOns": [ "INSURANCE", "SIGNATURE" ], "purchaseOrderId": "97108719025934786", "carrierName": "FedEx", "carrierServiceType": "FEDEX_2_DAY" } }, "sample3": { "value": { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 13, "boxLength": 13, "boxWidth": 9, "boxHeight": 0 }, "boxItems": [ { "lineNumber": "1", "sku": "PRECISE3PGLASS9", "quantity": 1, "productName": "racket", "productNameInLocale": "读写汉字" } ], "fromAddress": { "contactName": "Test Seller", "companyName": "Test Company", "addressLine1": "Add1", "addressLine2": "Add2", "city": "guangZhouShi", "state": "GD", "postalCode": "510599", "country": "CN", "phone": "12253", "email": "test@walmart.com" }, "returnAddress": { "contactName": "深圳市市盛天育科区游乡寺 - 10001223622 - MP", "addressLine1": "福田区石峡新田世纪商务中心B座36楼11室", "city": "深圳", "state": "系列", "postalCode": "581000", "country": "CN", "phone": "9087654589", "email": "sfsorderbatching@gmail.com", "shipNode": "765476571" }, "purchaseOrderId": "97108719025934786", "carrierName": "Yanwen", "carrierServiceType": "YANWEN_EXPRESS", "hasBattery": true } }, "sample4": { "value": { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 2, "boxLength": 2, "boxWidth": 2, "boxHeight": 2 }, "boxItems": [ { "sku": "SKUWfs6055469496189", "quantity": 1, "lineNumber": "1" } ], "fromAddress": { "contactName": "Shoes.com - 10900015173 - MP", "addressLine1": "2050 Royal Dr, Apt-7", "addressLine2": "Apt-7", "city": "SANTA CLARA", "state": "CA", "postalCode": "95050", "country": "US", "phone": "8024455150" }, "purchaseOrderId": "108919840486078", "carrierName": "FedEx", "carrierServiceType": "FEDEX_EXPRESS_SAVER", "accountType": "OWN", "shipOnDate": "2026-06-02" } }, "sample5": { "value": { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "KG", "boxWeight": 13, "boxLength": 13, "boxWidth": 9, "boxHeight": 0 }, "boxItems": [ { "lineNumber": "1", "sku": "SKUWfs6055469496189", "quantity": 1, "productName": "Boys tshirt", "hsCode": "12332412", "originState": "Delhi", "originCity": "Delhi", "countryOfOrigin": "IN" } ], "fromAddress": { "contactName": "Test Seller", "companyName": "Test Company", "addressLine1": "Add1", "addressLine2": "Add2", "city": "Bangalore", "state": "Karanataka", "postalCode": "560100", "country": "IN", "phone": "2074193432", "email": "test@walmart.com" }, "purchaseOrderId": "108913539040341", "carrierName": "FedEx", "carrierServiceType": "FEDEX_INTERNATIONAL_PRIORITY", "hazmat": false } } } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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": "The name of the product. This parameter is required if carrier is opted as 'Yanwen' and also for shipping from India(IN) to United-States(US)." }, "productNameInLocale": { "type": "string", "description": "The name of the product in Mandarin. This parameter is required 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": "Response payload containing the generated label tracking details." }, "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": "97108719025934786", "trackingNo": "10015361751436", "boxItems": [ { "sku": "PRECISE3PGLASS9", "quantity": 1, "lineNumber": "1" } ], "carrierName": "FedEx", "carrierFullName": "FedEx", "carrierServiceType": "FedEx 2Day", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=10015361751436&locale=en_US&cntry_code=us" } } }, "sample2": { "value": { "data": { "purchaseOrderId": "97108719025934786", "trackingNo": "10015361751436", "boxItems": [ { "sku": "PRECISE3PGLASS9", "quantity": 1, "lineNumber": "1" } ], "carrierName": "FedEx", "carrierFullName": "FedEx", "carrierServiceType": "FedEx 2Day", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=10015361751436&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" } ] } } }, "sample5": { "value": { "data": { "purchaseOrderId": "108919840486078", "trackingNo": "100625040279", "boxItems": [ { "sku": "SKUWfs6055469496189", "quantity": 1, "lineNumber": "1" } ], "carrierName": "FedEx", "carrierFullName": "FedEx", "carrierServiceType": "FedEx Express Saver", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=100625040279&locale=en_US&cntry_code=us" } } } } }, "application/pdf": { "schema": { "type": "object", "properties": { "data": { "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": "Response payload containing the generated label tracking details and, when requested, the label file." }, "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." } } } } }, "image/png": { "schema": { "type": "object", "properties": { "data": { "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": "Response payload containing the generated label tracking details and, when requested, the label file." }, "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." } } } } } } } } } } }, "components": { "securitySchemes": { "accessToken": { "type": "apiKey", "in": "header", "name": "WM_SEC.ACCESS_TOKEN", "description": "Access token from POST /v3/token (client_credentials grant)." } } } } ```