Skip to content
HALOWERK

Zollwerk

shipment hs edition crosswalk balance

Apply a supplied HS-edition crosswalk and return split quantities plus unmapped remainders.

POST https://zoll.halowerk.com/v1/shipment-hs-edition-crosswalk-balance

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
linesarrayYes
crosswalkarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "pattern": "^[0-9]{6}$"
          },
          "quantity": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000000000
          }
        },
        "required": [
          "code",
          "quantity"
        ],
        "additionalProperties": false
      },
      "maxItems": 100,
      "minItems": 1
    },
    "crosswalk": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "from": {
            "type": "string",
            "pattern": "^[0-9]{6}$"
          },
          "to": {
            "type": "string",
            "pattern": "^[0-9]{6}$"
          },
          "share_bps": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000
          }
        },
        "required": [
          "from",
          "to",
          "share_bps"
        ],
        "additionalProperties": false
      },
      "maxItems": 200,
      "minItems": 0
    }
  },
  "required": [
    "lines",
    "crosswalk"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "lines": [
    {
      "code": "850440",
      "quantity": 100
    }
  ],
  "crosswalk": [
    {
      "from": "850440",
      "to": "850440",
      "share_bps": 7000
    },
    {
      "from": "850440",
      "to": "850490",
      "share_bps": 2000
    }
  ]
}

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 โ†’