Home Depot UCC-128 Label Requirements

For more general information about Orderful's shipping label product, see Generate a UCC-128 (GS1-128) Label.

In addition to the type property with value THE_HOME_DEPOT, the following properties can be included in your label payload:

PropertyRequiredMax Length
shipFrom.nameYes20
shipFrom.address1Yes20
shipFrom.address2Yes20
shipFrom.cityYes15
shipFrom.stateYes2
shipFrom.zipYes5
shipTo.nameYes30
shipTo.address1Yes30
shipTo.address2Yes30
shipTo.cityYes15
shipTo.stateYes2
shipTo.zipYes5
carrier.nameYes30
shipment.proNumberYes30
shipment.billOfLadingNumberYes30
shipment.sscc-18Yes26
store.numberNo10
purchaseOrder.NumberYes40
pallet.numberYes10
pallet.maxYes10
carton.numberYes10

Example Payload

{
    "type": "THE_HOME_DEPOT",
    "shipFrom": {
        "name": "Your Company",
        "address1": "1234 Main St",
        "address2": "Unit 1",
        "city": "Pasadena",
        "state": "CA",
        "zip": "12345"
    },
    "shipTo": {
        "name": "The Home Depot",
        "address1": "2455 Paces Ferry Rd",
        "address2": "Unit 2",
        "city": "Atlanta",
        "state": "GA",
        "zip": "30339"
    },
    "carrier": {
        "name": "USPS"
    },
    "shipment": {
        "billOfLadingNumber": "ABC1234567890",
        "proNumber": "ABC1234567890",
        "sscc-18": "ABC1234567890ABC1234567890"
    },
    "store": {
        "number": "1234"
    },
    "purchaseOrder": {
        "number": "1234567890"
    },
    "pallet": {
        "number": 1,
        "max": 1
    },
    "carton": {
        "number": 1
    }
}

ZPL Response

Orderful will return a HTTP 201 Created along with the ZPL-format text to send to your label printer:

^XA
^CF0,25

^FO0,0^GB305,203,2^FS
^FO20,25^FDFrom:^FS
^FO20,50^FDYour Company^FS

[...]

^XZ

Home Depot Shipping Label Example