Skip to content
HALOWERK

Zollwerk

shipment preference bom threshold

Return lower and upper originating-material value shares under a caller-declared threshold.

POST https://zoll.halowerk.com/v1/shipment-preference-bom-threshold

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
exworks_centsintegerYes
minimum_sharenumberYes
materialsarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "exworks_cents": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000000000
    },
    "minimum_share": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "materials": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "value_cents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000000000
          },
          "origin": {
            "enum": [
              "originating",
              "nonoriginating",
              "unknown"
            ]
          }
        },
        "required": [
          "id",
          "value_cents",
          "origin"
        ],
        "additionalProperties": false
      },
      "maxItems": 100,
      "minItems": 1
    }
  },
  "required": [
    "exworks_cents",
    "minimum_share",
    "materials"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "exworks_cents": 10000,
  "minimum_share": 0.5,
  "materials": [
    {
      "id": "part_A",
      "value_cents": 4000,
      "origin": "originating"
    },
    {
      "id": "part_B",
      "value_cents": 3000,
      "origin": "unknown"
    }
  ]
}

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