Generate a UCC-128 (GS1-128) Label

Overview

Orderful offers a label printing API that generates a ZPL (Zebra Programming Language) file. This file can then be sent to a compatible printer to print a shipping label. The shipping labels Orderful generates include barcodes in GS1-128 (formerly UCC / EAN-128) format, including SSCC-18 barcodes where required.

Generating a shipping label is a three step process:

You POST to the /labels endpoint with the appropriate data for that company.
Orderful will respond with a text payload in ZPL format.
You Send the ZPL content to your printer.

📘
Print Density
Orderful's print templates are built for a print density of 8 dpmm (203 dpi). If you print a label and it appears much too big or small, please confirm your print density setting.

Currently Orderful supports generating shipping labels for the following companies:

Home Depot
Macy's
Nordstrom
Walmart (Case Domestic)

To request support for a different company, please contact Orderful Support.

Label Validation

If any required information is missing or otherwise non-compliant with either Orderful or the company's requirements, the API will return an error describing the problem. For example, if the "Ship From Name" is missing, the API will return the following error:

{
    "type": "argumentError",
    "ref": "user",
    "message": "There are errors with your label data.",
    "errors": [
        {
            "type": "argumentError",
            "ref": "shipFrom.name",
            "message": "Field must be provided for this label type."
        }
    ]
}

Shipping Label Examples

In order to use your Shipping Label API you will need to pass the label data to our /labels endpoint along with an API key for your organization.

📘
Authentication
For more information about retrieving and using your API Key please see the Authentication section of our API reference.

Home Depot

For a full description of our Home Depot JSON label requirements see our Home Depot Label Requirements.

Home Depot JSON 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
    }
}

Home Depot 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

Macy's

For a full description of our Macy's JSON label requirements see our Macy's Label Requirements.

Macy's JSON Payload

{
    "type": "MACYS",
    "shipFrom": {
        "name": "Your Company",
        "address1": "1234 Main St",
        "address2": "Unit 1",
        "city": "Pasadena",
        "state": "CA",
        "zip": "12345"
    },
    "shipTo": {
        "name": "Macy's",
        "careOf": "Secaucus Macy's Logistics DC",
        "address1": "500 Meadowlands Pkwy.",
        "address2": "Unit 2",
        "city": "Secaucus",
        "state": "NJ",
        "zip": "07094"
    },
    "carrier": {
        "name": "USPS"
    },
    "shipment": {
        "billOfLadingNumber": "ABC1234567890",
        "proNumber": "ABC1234567890",
        "sscc-18": "ABC1234567890ABC1234567890"
    },
    "purchaseOrder": {
        "number": "1234567890",
        "type": "REPLENISHMENT"
    },
    "department": {
        "number": "1234"
    },
    "store": {
        "number": "1234",
        "name": "Rochester"
    }
}

Macy's 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,20^FDFROM^FS
^FO20,50^FDYour Company^FS

[...]
 
^XZ

Macy's Shipping Label Example

Nordstrom

For a full description of our Nordstrom JSON label requirements see our Nordstrom Label Requirements.

Nordstrom JSON Payload

{
    "type": "NORDSTROM",
    "shipFrom": {
        "name": "Your Company",
        "address1": "1234 Main St",
        "address2": "Unit 1",
        "city": "Pasadena",
        "state": "CA",
        "zip": "12345"
    },
    "shipTo": {
        "name": "Nordstrom",
        "address1": "2345 2nd St",
        "address2": "Unit 2",
        "city": "New York",
        "state": "NY",
        "zip": "23456"
    },
    "carrier": {
        "name": "USPS"
    },
    "shipment": {
        "billOfLadingNumber": "ABC1234567890",
        "proNumber": "ABC1234567890",
        "sscc-18": "ABC1234567890ABC1234567890"
    },
    "purchaseOrder": {
        "number": "1234567890"
    },
    "department": {
        "number": "1234"
    },
    "distributionCenter": {
        "number": "1234"
    },
    "case": {
        "pack": 1
    },
    "carton": {
        "max": 1,
        "number": 1
    },
    "store": {
        "number": "1234"
    }
}

Nordstrom 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,162,2^FS
^FO15,10^FDFrom^FS
^FO40,30^FDYour Company^FS

[...]
 
^XZ

Nordstrom Shipping Label Example

Walmart (Case Domestic)

📘
This is the shipping label for a domestic case shipment. Other types of shipping labels are not currently supported.

For a full description of our Walmart JSON label requirements see our Walmart Label Requirements

Walmart JSON Payload

{
    "type": "WALMART_CASE_DOMESTIC",
    "shipFrom": {
        "name": "Your Company",
        "address1": "1234 Main St",
        "address2": "Unit 1",
        "city": "Pasadena",
        "state": "CA",
        "zip": "12345"
    },
    "shipTo": {
        "name": "Walmart DC 1234",
        "address1": "2345 2nd St",
        "address2": "Unit 2",
        "city": "New York",
        "state": "NY",
        "zip": "23456"
    },
    "carrier": {
        "name": "USPS"
    },
    "shipment": {
        "billOfLadingNumber": "ABC1234567890",
        "proNumber": "ABC1234567890",
        "sscc-18": "ABC1234567890ABC1234567890"
    },
    "purchaseOrder": {
        "number": "1234567890",
        "type": "1234"
    },
    "department": {
        "number": "1234"
    },
    "distributionCenter": {
        "number": "1234"
    },
    "item": {
        "number": "1234567890"
    }
}

Walmart 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,270,2^FS
^FO20,20^FDShip From:^FS
^FO20,60^FDYour Company^FS

[...]

^XZ

Walmart Shipping Label Example

Report an Error

If you experience any problems with your shipping label, please contact Orderful support.