Issues Worklist

Read the orders of a customs pipeline that are not ready, with the failed checks and the scored fields that differ from the filed declaration or are missing.

GET /v1/customs-declaration/issues is the short list a clerk works through. It returns the orders of a pipeline that are not ready, which means at least one of the seven checks failed, and for each order the failed checks and the scored fields whose extracted value differs from the filed declaration or is missing. When pipeline_id is omitted, the pipeline is chosen exactly as for the declarations route: the newest completed eligible pipeline, else the newest eligible one.

Each entry carries the order's lrn, its record_document_id, sender and receiver, and two lists. checks[] holds only the failed checks, each with id, message and fields; passing and not-applicable checks are left out. differs lists the field keys of scored comparison rows whose state is mismatch or missing, and rows with state partial, no_reference, empty or info are not listed. The envelope names the pipeline read.

The worklist is selected by checks, not by differences: an order whose checks all pass is ready and is not listed even when differs would be non-empty. To find every order with a difference, read the declarations route and filter on comparison and tally. The same visibility rules apply as for the declarations route: orders are read as the key's minting user may see them under Sources IAM, and records held back for review are not included.

curl "https://api.talonic.com/v1/customs-declaration/issues?pipeline_id=$PIPELINE_ID" \
  -H "Authorization: Bearer $TALONIC_API_KEY"

{
  "pipeline": { "id": "9c4e7a12-6d03-4b58-b1f7-3e8a0d5c2f46", "name": "October consignments", "status": "completed" },
  "data": [
    {
      "lrn": "26DE0012345679",
      "record_document_id": "7b3d0e58-1c46-4a92-85f7-e2a9c6d4b018",
      "sender": "Rhein Logistik GmbH",
      "receiver": "Piraeus Trading SA",
      "checks": [
        {
          "id": "packages-fit",
          "message": "Please check the packages: 80 pallets exceeds 34 (usually items counted instead of pallets)",
          "fields": ["packages_count", "package_type_code"]
        }
      ],
      "differs": ["packages_count", "hs_codes"]
    }
  ]
}