Skip to content
HALOWERK

Bildwerk

label render

Templates: shipping (sender, recipient, service, weight, Code 128 tracking, optional SSCC as GS1-128) and product (name, EAN-13/UPC-A/EAN-8 or GS1-128 from the GTIN, GS1 DataMatrix with expiry, batch and serial, price); or a custom list of text, barcode, box and line elements in millimetres. GTIN and SSCC check digits and GS1 element strings are validated, barcode module widths are rounded to whole printer dots for 203/300/600 dpi and fitted to the label. Output: ZPL (^CI28 UTF-8, ^PW/^LL.

POST https://bild.halowerk.com/v1/label-render

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
templatestringNo
width_mmnumberNo
height_mmnumberNo
dpiintegerNo
elementsarrayNo
shippingobjectNo
productobjectNo
outputstringNo
verifybooleanNoRender the ZPL and decode all barcodes.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "template": {
      "type": "string",
      "enum": [
        "custom",
        "shipping",
        "product"
      ],
      "default": "custom"
    },
    "width_mm": {
      "type": "number",
      "minimum": 10,
      "maximum": 300
    },
    "height_mm": {
      "type": "number",
      "minimum": 10,
      "maximum": 400
    },
    "dpi": {
      "type": "integer",
      "enum": [
        203,
        300,
        600
      ],
      "default": 203
    },
    "elements": {
      "type": "array",
      "minItems": 1,
      "maxItems": 60,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "type",
          "x_mm",
          "y_mm"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "text",
              "barcode",
              "box",
              "line"
            ]
          },
          "x_mm": {
            "type": "number",
            "minimum": 0,
            "maximum": 400
          },
          "y_mm": {
            "type": "number",
            "minimum": 0,
            "maximum": 400
          },
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300
          },
          "size_mm": {
            "type": "number",
            "minimum": 1,
            "maximum": 60,
            "description": "Text height."
          },
          "bold": {
            "type": "boolean"
          },
          "width_mm": {
            "type": "number",
            "minimum": 0.1,
            "maximum": 400
          },
          "height_mm": {
            "type": "number",
            "minimum": 0.1,
            "maximum": 400
          },
          "max_lines": {
            "type": "integer",
            "minimum": 1,
            "maximum": 20
          },
          "symbology": {
            "type": "string",
            "enum": [
              "code128",
              "gs1-128",
              "ean13",
              "ean8",
              "upca",
              "code39",
              "qrcode",
              "datamatrix",
              "gs1datamatrix"
            ]
          },
          "data": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000
          },
          "module_mm": {
            "type": "number",
            "minimum": 0.1,
            "maximum": 5,
            "description": "Narrow bar / module width (X)."
          },
          "human_readable": {
            "type": "boolean"
          },
          "thickness_mm": {
            "type": "number",
            "minimum": 0.1,
            "maximum": 50
          },
          "filled": {
            "type": "boolean"
          },
          "direction": {
            "type": "string",
            "enum": [
              "horizontal",
              "vertical"
            ]
          },
          "length_mm": {
            "type": "number",
            "minimum": 0.1,
            "maximum": 400
          }
        }
      }
    },
    "shipping": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "sender",
        "recipient",
        "tracking"
      ],
      "properties": {
        "sender": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "postal_code",
            "city"
          ],
          "properties": {
            "company": {
              "type": "string",
              "maxLength": 60
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 60
            },
            "street": {
              "type": "string",
              "maxLength": 60
            },
            "postal_code": {
              "type": "string",
              "minLength": 1,
              "maxLength": 12
            },
            "city": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "country": {
              "type": "string",
              "maxLength": 40
            }
          }
        },
        "recipient": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "postal_code",
            "city"
          ],
          "properties": {
            "company": {
              "type": "string",
              "maxLength": 60
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 60
            },
            "street": {
              "type": "string",
              "maxLength": 60
            },
            "postal_code": {
              "type": "string",
              "minLength": 1,
              "maxLength": 12
            },
            "city": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "country": {
              "type": "string",
              "maxLength": 40
            }
          }
        },
        "tracking": {
          "type": "string",
          "minLength": 1,
          "maxLength": 48
        },
        "sscc": {
          "type": "string",
          "pattern": "^\\d{18}$"
        },
        "reference": {
          "type": "string",
          "maxLength": 40
        },
        "weight_kg": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000
        },
        "service": {
          "type": "string",
          "maxLength": 20
        }
      }
    },
    "product": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name",
        "gtin"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80
        },
        "gtin": {
          "type": "string",
          "pattern": "^\\d{8,14}$"
        },
        "batch": {
          "type": "string",
          "maxLength": 20
        },
        "expiry": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        "serial": {
          "type": "string",
          "maxLength": 20
        },
        "price": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "amount"
          ],
          "properties": {
            "amount": {
              "type": "number",
              "minimum": 0
            },
            "currency": {
              "type": "string",
              "maxLength": 3
            }
          }
        }
      }
    },
    "output": {
      "type": "string",
      "enum": [
        "zpl",
        "pdf",
        "both"
      ],
      "default": "both"
    },
    "verify": {
      "type": "boolean",
      "default": true,
      "description": "Render the ZPL and decode all barcodes."
    }
  }
}

Open original schema

Published input example

{
  "template": "shipping",
  "shipping": {
    "sender": {
      "name": "Werkstatt Nord",
      "postal_code": "48599",
      "city": "Gronau"
    },
    "recipient": {
      "name": "Versandabteilung Nord",
      "street": "Hauptstraße 5",
      "postal_code": "10115",
      "city": "Berlin",
      "country": "DE"
    },
    "tracking": "HW1000042DE",
    "service": "PAKET"
  }
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →