Create label with multi-package

Market availability: CA, MX

The Create label with multi package API creates shipping labels for orders with multiple packages.

Endpoint

POST https://marketplace.walmartapis.com/v3/shipping/multi-package/labels

Function

Key features of this API include:

Multi-package shipping simplification: Create and manage shipping labels for orders with multiple packages to the same buyer. Sellers can define package-specific details, such as dimensions, weight, and contents, for each box.
Streamlined label creation: Generates shipping labels for each package in an order. This is useful for large or bulk orders that exceed the size or weight limitations for a single parcel.
Walmart's shipping discounts: Provides discounted rates with shipping carriers (such as FedEx, USPS, UPS) to reduce your shipping
Tracking and order management: Once the labels are created, the system generates unique tracking numbers for each package. These tracking details are automatically updated in Walmart’s Marketplace dashboard, providing both sellers and buyers with real-time shipment visibility.
Compliance and efficiency: Ensures your orders are aligned with Walmart's shipping and order fulfillment requirements, such as estimated delivery times and packaging standards.

Request samples

SWW sample (CA and MX)

curl --request POST \ --url https://marketplace.walmartapis.com/v3/shipping/multi-package/labels \ --header 'Accept: application/json' \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: mx' \ --header 'content-type: application/json' \ --data '
{ "packageDimensions": [ { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 3, "boxLength": 9, "boxWidth": 12, "boxHeight": 1 } }, { "packageType": "FEDEX_PAK", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 3, "boxLength": 9, "boxWidth": 12, "boxHeight": 1 } }, { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 3, "boxLength": 9, "boxWidth": 12, "boxHeight": 1 } } ], "boxItems": [ { "sku": "EDF07661449630550", "quantity": 1, "countryOfOrigin": "MX", "lineNumber": "1" } ], "fromAddress": { "contactName": "Test", "companyName": "Walmart", "addressLine1": "Add1", "addressLine2": "Add2", "city": "Anchorage", "state": "AK", "postalCode": "99501", "country": "US", "phone": "12253", "email": "[email protected]" }, "purchaseOrderId": "309006496534952", "carrierName": "FedEx", "carrierServiceType": "FEDEX_INTERNATIONAL_ECONOMY"
}
'

SWW Sample for FEDEX_PAK/FEDEX_ENVELOP (CA and MX)

curl --request POST \ --url https://marketplace.walmartapis.com/v3/shipping/multi-package/labels \ --header 'Accept: application/json' \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: mx' \ --header 'content-type: application/json' \ --data '
{ "packageDimensions": [ { "packageType": "FEDEX_PAK", "boxDimensions": { "boxWeightUnit": "LB", "boxWeight": 3 } }, { "packageType": "FEDEX_ENVELOPE", "boxDimensions": { "boxWeightUnit": "LB", "boxWeight": 9 } } ], "boxItems": [ { "sku": "EDF07661449630550", "quantity": 1, "countryOfOrigin": "US", "lineNumber": "1" } ], "fromAddress": { "contactName": "Test", "companyName": "Walmart", "addressLine1": "Add1", "addressLine2": "Add2", "city": "Anchorage", "state": "AK", "postalCode": "99501", "country": "US", "phone": "12253", "email": "[email protected]" }, "purchaseOrderId": "309006496534952", "carrierName": "FedEx", "carrierServiceType": "FEDEX_INTERNATIONAL_ECONOMY"
}
'

MX WPS sample

curl --request POST \ --url https://marketplace.walmartapis.com/v3/shipping/multi-package/labels \ --header 'Accept: application/json' \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: mx' \ --header 'content-type: application/json' \ --data '
{ "packageDimensions": [ { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 3, "boxLength": 9, "boxWidth": 12, "boxHeight": 1 } }, { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 3, "boxLength": 9, "boxWidth": 12, "boxHeight": 1 } }, { "packageType": "CUSTOM_PACKAGE", "boxDimensions": { "boxDimensionUnit": "IN", "boxWeightUnit": "LB", "boxWeight": 3, "boxLength": 9, "boxWidth": 12, "boxHeight": 1 } } ], "boxItems": [ { "sku": "EDF07661449630550", "quantity": 1, "countryOfOrigin": "MX", "lineNumber": "1" } ], "fromAddress": {}, "purchaseOrderId": "309006496534952"
}
'

Modify your code

For the SWW request, update the following fields as needed:

packageDimensions: Add an object for each package being shipped
boxDimensions: Set the correct length, width, height, weight, and units for each box
boxItems: Include the real SKU, quantity, line number, and country of origin
fromAddress: Provide the ship from contact and address details
purchaseOrderId: Use the actual purchase order ID
carrierName and carrierServiceType: Use the carrier values supported for the order

Response samples

application/json

200 - Sample 1-MX

{ "data": { "purchaseOrderId": "609104165932095", "trackingNo": "MXFDDWM00625747", "boxItems": [ { "sku": "07697650768898", "quantity": 1, "lineNumber": "1" } ], "carrierName": "WALMART", "carrierFullName": "WALMART", "carrierServiceType": "MX", "trackingUrl": "https://www.walmart.com.mx/tu-cuenta/pedidos/701770627529789/track/MXFDDWM00625747", "shippingDocuments": [ { "documentFormat": "ZPL", "documentType": "LABEL", "base64EncodedDocument": "^XA\n^CI28\n^XA^PW812^FO10,10^GB800,1600,3,,^FS\n^FO10,10^GB800,330,3,,^FS\n^FO20,25^A0,30,^FH^FDDe^FS\n^FO60,25^A0,30,^FH^FDMPCOEE_Automation_Test_1233_edit español 123^FS\n^FO45,60^A0,30,^FH^FD^FS\n^FO45,100^A0,30,^FH^FDAV. RIO NILO NO. 3314:113134 español 11111 | ^FS\n^FO45,140^A0,30,^FH^FDchiapas español test^FS\n^FO45,180^A0,30,^FH^FD,^FS\n^FO45,220^A0,30,^FH^FDDISTRITO FEDERAL guan^FS\n^FO45,260^A0,30,^FH^FDVeracruz de Ignacio de la Llave,11220^FS\n^FO45,300^A0,30,^FD+01 800 968 2661^FS\n^FO20,350^A0,30,^FH^FDPara^FS\n^FO80,350^A0,30,^FH^FDTest COMS^FS\n^FO60,385^A0,30,^FH^FD^FS\n^FO60,420^A0,30,^FH^FDVishnupriya | 4353454654^FS\n^FO60,455^A0,30,^FH^FD^FS\n^FO60,490^A0,30,^FH^FD,^FS\n^FO60,525^A0,30,^FH^FDCIUDAD DE MEXICO,DISTRITO FEDERAL,11220 MX^FS\n^FO600,25^A0,30,^FH^FD9999999999^FS\n^FO545,385^A0,30,^FH^FD3454646745^FS\n^FO20,580^A0,30,^FH^FDMXFDD^FS\n^FO10,570^GB400,230,2,,^FS\n^FO406,570^GB404,230,2,,^FS\n^FO415,580^A0,30,^FDShipment Order No #: ^FS\n^FO415,620^A0,30,^FD 701770627529789^FS\n^FO415,660^A0,30,^FD Piece:1 of 1 ^FS\n^FO20,820^A0,30,^FDTracking # :^FS\n^FO10,970^GB800,149,3,,^FS\n^FO20,1005^A0,30,^FD1) DD/MM : ____________^FS\n^FO405,1005^A0,30,^FD2) DD/MM : ____________^FS\n^FO20,1070^A0,30,^FD3) DD/MM : ____________^FS\n^FO400,1060^GB40,40,3,B,^FS\n^FO460,1070^A0,30,^FH^FDdevolución^FS\n^FO10,1115^GB800,157,3,,^FS\n ^FO20,1130^A0,30,^FH^FDshipViaMethod : 75060023^FS\n ^FO430,1130^A0,30,^FH^FDshipViaOrder : 701770627529789^FS\n ^FO20,1230^A0,30,^FH^FDdim : 9.0*11.0*2.0CM50.0KG^FS\n ^FO20,1180^A0,30,^FH^FDshipViaPo : 609104165932095^FS\n ^FO440,1180^A0,30,^FH^FDmax edd : 2026-02-18^FS\n ^FO20,1500^A0,30,^FH^FDcalles : ^FS\n ^FO20,1550^A0,30,^FH^FDref : ^FS\n ^FO410,1470^A0,30,^FDCustomer Secondary Phone :^FS\n ^FO410,1570^A0,30,^FD^FS\n ^FO20,1280^A0,30,^FDAssociate Scan Carton Number Below^FS\n ^FO180,1320^BY3^BCN,75,N,,,A^FD1^FS\n ^FO180,1410^FB500,1,2,C,0^A0,30,30^FD1^FS\n^FO10,1450^GB800,160,3,,^FS\n^FO100,850^BY3^BCN,65,N,,,A^FDMXFDDWM00625747^FS\n^FO250,935^A0,35,^FDMXFDDWM00625747^FS\n ^FO625,425^GFA,2176,2176,16,,::::::::::::::::V02,V07,V0F8,U01FE,U03FF,N03IFC00IF8,N03IFE01IFC,N03IFE03IFE,N03IFC07JF,O0IF00KFC,O07FF01KFE,O07FF03FF8IF,O07FF0IF07FF8,O07FF1FFE03FFC,O07FF3FFC01FFE,O07FF7FF800IF,O07KFI03FFC,O07JFEI01FFE,O07JF80300IF,O07JF00F807FF8,O07IFE01FC03FFC,O07IFC03FE01FFE,O07IF807FF007FF,O07IF00IF803FFC,O07FFC01IFE01FFE,O07FF807JF00IF,O0IF00KF807FF8,N01FFE01KFC03FFC,N03FFC03KFE01FFE,N07FF807FF0IF007FF8,N0FFE00FFE03FFC03FFC,M01FFC03FF801FFE01FFE,M07FF807FF800IF00IF,M0IF00IFI0IF807FF8,L01FFE01IFI0IFC03FFC,L03FFC03IFI0IFE01FFE,L07FF807IFI0JF00IF8,L0FFE00JF800JFC03FFC,K03FFC03JF801JFE01FFE,K07FF807JFC01KF00IF,K0IF00KFE07KF807FF8,J01FFE01LFDLFC03FFC,J03FFC03SFE00FFE,J07FF807TF007FF,J03FF00UFC03FE,J01FC03UFE01FC,K0F807VF00F8,K0700WF807,K0601WFC03,M01WFC,:::::M01IFJ01FFCJ07FC,:M01IF011B1FFCFEFF3FC,M01IF3F3F9FFCFEFF3FC,:M01IF3F3F9FFCFEFF7FC,M01IF3F3F9FFCFE7F7FC,M01IF3F3F9FFCFE7E7FC,M01IF3F1F9FFCJ07FC,M01IFJ01FFCFE7E7FC,M01IFJ01FFCFEFF3FC,M01IF3F3F9FFCFEFF7FC,:M01IF3F3F9FFCFEFF3FC,M01IF3F3F9FFCFEFF7FC,M01IF3F3F9FFCJ07FC,:M01IFJ01OFC,:M01IF3F1F9OFC,M01IF3F3F9OFC,::::M01FFE3F3F9OFC,M01IF3F3F9OFC,M01IF3F1F1OFC,M01IFJ01OFC,:M03WFE,:::::::,:::::::::::::::::::gG0A,L0200B1J02,Q01001N01,,::^FS\n^FO490,545^A0,30,^FH^FD^FS\n^FO170,1005^A0,30,^FD^FS\n^FO170,1070^A0,30,^FD^FS\n^FO550,1005^A0,30,^FD^FS\n^FO20,650^A0,60,^FDGDL2 STD^FS\n^FO20,720^A0,50,^FDZ 16 - 2 01^FS\n^FO455,710^A0,30,^FH^FDPDD :^FS\n^FO545,710^A0,30,^FD2026-02-18^FS\n^FO420,750^A0,30,^FD2026-02-09T10:24^FS^XZ" } ], "otherLabels": [ { "trackingNo": "MXFDDWM00624925", "trackingUrl": "https://www.walmart.com.mx/tu-cuenta/pedidos/701770627529789/track/MXFDDWM00624925", "shippingDocuments": [ { "documentFormat": "ZPL", "documentType": "LABEL", "base64EncodedDocument": "^XA\n^CI28\n^XA^PW812^FO10,10^GB800,1600,3,,^FS\n^FO10,10^GB800,330,3,,^FS\n^FO20,25^A0,30,^FH^FDDe^FS\n^FO60,25^A0,30,^FH^FDMPCOEE_Automation_Test_1233_edit español 123^FS\n^FO45,60^A0,30,^FH^FD^FS\n^FO45,100^A0,30,^FH^FDAV. RIO NILO NO. 3314:113134 español 11111 | ^FS\n^FO45,140^A0,30,^FH^FD | chiapas español test^FS\n^FO45,180^A0,30,^FH^FD,^FS\n^FO45,220^A0,30,^FH^FDDISTRITO FEDERAL guan^FS\n^FO45,260^A0,30,^FH^FDVeracruz de Ignacio de la Llave,11220^FS\n^FO45,300^A0,30,^FD+01 800 968 2661^FS\n^FO20,350^A0,30,^FH^FDPara^FS\n^FO80,350^A0,30,^FH^FDTest COMS^FS\n^FO60,385^A0,30,^FH^FD^FS\n^FO60,420^A0,30,^FH^FDVishnupriya | 4353454654^FS\n^FO60,455^A0,30,^FH^FD^FS\n^FO60,490^A0,30,^FH^FD,^FS\n^FO60,525^A0,30,^FH^FDCIUDAD DE MEXICO,DISTRITO FEDERAL,11220 MX^FS\n^FO600,25^A0,30,^FH^FD9999999999^FS\n^FO545,385^A0,30,^FH^FD3454646745^FS\n^FO20,580^A0,30,^FH^FDMXFDD^FS\n^FO10,570^GB400,230,2,,^FS\n^FO406,570^GB404,230,2,,^FS\n^FO415,580^A0,30,^FDShipment Order No #: ^FS\n^FO415,620^A0,30,^FD 701770627529789^FS\n^FO415,660^A0,30,^FD Piece:1 of 1 ^FS\n^FO20,820^A0,30,^FDTracking # :^FS\n^FO10,970^GB800,149,3,,^FS\n^FO20,1005^A0,30,^FD1) DD/MM : ____________^FS\n^FO405,1005^A0,30,^FD2) DD/MM : ____________^FS\n^FO20,1070^A0,30,^FD3) DD/MM : ____________^FS\n^FO400,1060^GB40,40,3,B,^FS\n^FO460,1070^A0,30,^FH^FDdevolución^FS\n^FO10,1115^GB800,157,3,,^FS\n ^FO20,1130^A0,30,^FH^FDshipViaMethod : 75060023^FS\n ^FO430,1130^A0,30,^FH^FDshipViaOrder : 701770627529789^FS\n ^FO20,1230^A0,30,^FH^FDdim : 500.0*100.0*200.0IN50.0KG^FS\n ^FO20,1180^A0,30,^FH^FDshipViaPo : 609104165932095^FS\n ^FO440,1180^A0,30,^FH^FDmax edd : 2026-02-18^FS\n ^FO20,1500^A0,30,^FH^FDcalles : ^FS\n ^FO20,1550^A0,30,^FH^FDref : ^FS\n ^FO410,1470^A0,30,^FDCustomer Secondary Phone :^FS\n ^FO410,1570^A0,30,^FD^FS\n ^FO20,1280^A0,30,^FDAssociate Scan Carton Number Below^FS\n ^FO180,1320^BY3^BCN,75,N,,,A^FD1^FS\n ^FO180,1410^FB500,1,2,C,0^A0,30,30^FD1^FS\n^FO10,1450^GB800,160,3,,^FS\n^FO100,850^BY3^BCN,65,N,,,A^FDMXFDDWM00624925^FS\n^FO250,935^A0,35,^FDMXFDDWM00624925^FS\n ^FO625,425^GFA,2176,2176,16,,::::::::::::::::V02,V07,V0F8,U01FE,U03FF,N03IFC00IF8,N03IFE01IFC,N03IFE03IFE,N03IFC07JF,O0IF00KFC,O07FF01KFE,O07FF03FF8IF,O07FF0IF07FF8,O07FF1FFE03FFC,O07FF3FFC01FFE,O07FF7FF800IF,O07KFI03FFC,O07JFEI01FFE,O07JF80300IF,O07JF00F807FF8,O07IFE01FC03FFC,O07IFC03FE01FFE,O07IF807FF007FF,O07IF00IF803FFC,O07FFC01IFE01FFE,O07FF807JF00IF,O0IF00KF807FF8,N01FFE01KFC03FFC,N03FFC03KFE01FFE,N07FF807FF0IF007FF8,N0FFE00FFE03FFC03FFC,M01FFC03FF801FFE01FFE,M07FF807FF800IF00IF,M0IF00IFI0IF807FF8,L01FFE01IFI0IFC03FFC,L03FFC03IFI0IFE01FFE,L07FF807IFI0JF00IF8,L0FFE00JF800JFC03FFC,K03FFC03JF801JFE01FFE,K07FF807JFC01KF00IF,K0IF00KFE07KF807FF8,J01FFE01LFDLFC03FFC,J03FFC03SFE00FFE,J07FF807TF007FF,J03FF00UFC03FE,J01FC03UFE01FC,K0F807VF00F8,K0700WF807,K0601WFC03,M01WFC,:::::M01IFJ01FFCJ07FC,:M01IF011B1FFCFEFF3FC,M01IF3F3F9FFCFEFF3FC,:M01IF3F3F9FFCFEFF7FC,M01IF3F3F9FFCFE7F7FC,M01IF3F3F9FFCFE7E7FC,M01IF3F1F9FFCJ07FC,M01IFJ01FFCFE7E7FC,M01IFJ01FFCFEFF3FC,M01IF3F3F9FFCFEFF7FC,:M01IF3F3F9FFCFEFF3FC,M01IF3F3F9FFCFEFF7FC,M01IF3F3F9FFCJ07FC,:M01IFJ01OFC,:M01IF3F1F9OFC,M01IF3F3F9OFC,::::M01FFE3F3F9OFC,M01IF3F3F9OFC,M01IF3F1F1OFC,M01IFJ01OFC,:M03WFE,:::::::,:::::::::::::::::::gG0A,L0200B1J02,Q01001N01,,::^FS\n^FO490,545^A0,30,^FH^FD^FS\n^FO170,1005^A0,30,^FD^FS\n^FO170,1070^A0,30,^FD^FS\n^FO550,1005^A0,30,^FD^FS\n^FO20,650^A0,60,^FDGDL2 STD^FS\n^FO20,720^A0,50,^FDZ 16 - 2 01^FS\n^FO455,710^A0,30,^FH^FDPDD :^FS\n^FO545,710^A0,30,^FD2026-02-18^FS\n^FO420,750^A0,30,^FD2026-02-09T10:24^FS^XZ" } ] } ] }
}

200 - Sample 2-CA

{ "data": { "purchaseOrderId": "609104165932095", "trackingNo": "471361497660", "boxItems": [ { "sku": "07697650764598", "lineNumber": "1", "quantity": 1 } ], "carrierName": "FedEx", "carrierFullName": "FedEx", "carrierServiceType": "FedEx International Economy", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=471361497660&locale=en_US&cntry_code=us", "shippingDocuments": [ { "documentFormat": "PDF", "documentType": "LABEL", "base64EncodedDocument": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9BdXRob3IgKE5lb2R5bmFtaWMgXCh3d3cubmVvZHluYW1pYy5jb21cKSkKL0NyZWF0b3IgKFpQTFByaW50ZXIgRW11bGF0b3IgU0RLIDYuMC4yNC45MTEpCi9Qcm9kdWNlciAoWlBMUHJpbnRlciBFbXVsYXRvciBTREsgNi4wLjI0LjkxMSkKL0NyZWF0aW9uRGF0ZSAoRDoyMDI1MDcyOTEzNDAzOCswMCcwMCcpPj4KZW5kb2JqCjMgMCBvYmoKPDwvY2EgMQovQk0gL05vcm1hbD4+CmVuZG9iago0IDAgb2JqCjw8L1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0ltYWdlCi9XaWR0aCAxNzI2Ci9IZWlnaHQgMjIzMwovQ29sb3JTcGFjZSAvRGV2aWNlUkdCCi9CaXRzUGVyQ29tcG9uZW50IDgKL0ZpbHRlciAvRENURGVjb2RlCi9Db2xvclRyYW5zZm9ybSAwCiMCBSCi9JbmZvIDEgMCBSPj4Kc3RhcnR4cmVmCjMwMjcxMgolJUVPRg==" } ], "id": "89B673E6C8200000F20FC051", "otherLabels": [ { "trackingNo": "471361497670", "trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=471361497670&locale=en_US&cntry_code=us", "shippingDocuments": [ { "documentFormat": "PDF", "documentType": "LABEL", "base64EncodedDocument": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9BdXRob3IgKE5lb2R5bmFtaWMgXCh3d3cubmVvZHluYW1pYy5jb21cKSkKL0NyZWF0b3IgKFpQTFByaW50ZXIgRW11bGF0b3IgU0RLIDYuMC4yNC45MTEpCi9Qcm9kdWNlciAoWlBMUHJpbnRlciBFbXVsYXRvciBTREsgNi4wLjI0LjkxMSkKL0NyZWF0aW9uRGF0ZSAoRDoyMDI1MDcyOTEzNDAzOCswMCcwMCcpPj4KZW5kb2JqCjMgMCBvYmoKPDwvY2EgMQovQk0gL05vcm1hbD4+CmVuZG9iago0IDAgb2JqCjw8L1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0ltYWdlCi9XaWR0aCAxNzI2Ci9IZWlnaHQgMjIzMwovQ29sb3JTcGFjZSAvRGV2aWNlUkdCCi9CaXRzUGVyQ29tcG9uZW50IDgKL0ZpbHRlciAvRENURGVjb2RlCi9Db2xvclRyYW5zZm9ybSAwCi9MZW5ndGggMzA1NzMwPj4gcfghiuuujjozMDY2NjcKJSVFT0Y=" } ] } ] }
}

400

[ { "code": "string", "field": "string", "description": "string", "info": "string", "severity": "string", "category": "string", "errorIdentifiers": { "entry": [ {} ] } }
]

500

{ "errors": [ { "info": "string", "code": "string", "field": "string", "description": "string", "severity": "string", "category": "string", "httpStatus": 0 } ]
}

application/pdf

200

{ "data": { "purchaseOrderId": "string", "id": "string", "trackingNo": "string", "boxItems": [ { "sku": "string", "quantity": 0, "lineNumber": "string" } ], "carrierName": "string", "carrierFullName": "string", "carrierServiceType": "string", "trackingUrl": "string", "shippingDocuments": { "documentFormat": "string", "documentType": "string", "base64EncodedDocument": "string" }, "otherLabels": [ { "trackingNo": "string", "trackingUrl": "string", "shippingDocuments": [ { "documentFormat": "string", "documentType": "string", "base64EncodedDocument": "string" } ] } ] }, "errors": [ { "info": "string", "code": "string", "field": "string", "description": "string", "severity": "EMERG", "category": "APPLICATION", "httpStatus": 0 } ]
}

image/png

200

{ "data": { "purchaseOrderId": "string", "id": "string", "trackingNo": "string", "boxItems": [ { "sku": "string", "quantity": 0, "lineNumber": "string" } ], "carrierName": "string", "carrierFullName": "string", "carrierServiceType": "string", "trackingUrl": "string", "shippingDocuments": { "documentFormat": "string", "documentType": "string", "base64EncodedDocument": "string" }, "otherLabels": [ { "trackingNo": "string", "trackingUrl": "string", "shippingDocuments": [ { "documentFormat": "string", "documentType": "string", "base64EncodedDocument": "string" } ] } ] }, "errors": [ { "info": "string", "code": "string", "field": "string", "description": "string", "severity": "EMERG", "category": "APPLICATION", "httpStatus": 0 } ]
}

Result

A successful response returns shipment label data in the data object. Key fields include:

purchaseOrderId: the purchase order associated with the shipment
trackingNo: the shipment tracking number
boxItems: the item list included in the shipment
carrierName and carrierFullName: the carrier used to create the label
carrierServiceType: the shipping service selected
trackingUrl: a link customers or operators can use to track the shipment
shippingDocuments: the label file encoded in base64
otherLabels: additional package labels created for the same purchase order

For MX responses, the label can return as ZPL and may include multiple labels under otherLabels. For CA responses, the label can return as PDF. If the request is invalid, the API can return a 400 error with field-level validation details or a 500 error for server-side issues.

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 Supported carrier package types API provides the package types a carrier offers.

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 5 days ago

Did this page help you?