Skip to content
HALOWERK

Zollwerk

shipment document line coverage

Return document coverage.

POST https://zoll.halowerk.com/v1/shipment-document-line-coverage

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
linesarrayYes
typesarrayYes
documentsarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/$defs/s0"
          },
          "qty": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000
          }
        },
        "required": [
          "id",
          "qty"
        ],
        "additionalProperties": false
      },
      "maxItems": 100,
      "minItems": 1
    },
    "types": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/s0"
      },
      "maxItems": 10,
      "minItems": 1
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/$defs/s0"
          },
          "type": {
            "$ref": "#/$defs/s0"
          },
          "covers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "line": {
                  "$ref": "#/$defs/s0"
                },
                "qty": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 1000000000
                }
              },
              "required": [
                "line",
                "qty"
              ],
              "additionalProperties": false
            },
            "maxItems": 100,
            "minItems": 1
          }
        },
        "required": [
          "id",
          "type",
          "covers"
        ],
        "additionalProperties": false
      },
      "maxItems": 100,
      "minItems": 0
    }
  },
  "required": [
    "lines",
    "types",
    "documents"
  ],
  "additionalProperties": false,
  "$id": "urn:h:w4:E8:input",
  "$defs": {
    "s0": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

Open original schema

Published input example

{
  "lines": [
    {
      "id": "A",
      "qty": 10
    }
  ],
  "types": [
    "INV",
    "COO"
  ],
  "documents": [
    {
      "id": "INV17",
      "type": "INV",
      "covers": [
        {
          "line": "A",
          "qty": 10
        }
      ]
    }
  ]
}

Result & documentation

Machine-readable documentation of this hub

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

More endpoints in this hub

All endpoints in this hub โ†’