Shipment tracking

Provider events when available, otherwise an explicit availability status.

Kind: shipment_tracking
Availability: available
Registry cost category: none
Lifecycle stage IDs: tracking, delivery

The cost category describes model work in the registry; it is not a manufacturing price or a monetary quote. Read maglev actions kinds --json for current availability and schemas.

What this does

Inspect the output availability. A registered action is not proof that a carrier credential is configured: planned means no provider request was made; unavailable means no usable provider result.

Input

Send these fields inside the request’s input object. Use only facts you have, and keep unresolved requirements explicit. Optional fields with defaults can be omitted.

Field	Type	Required	Details
`carrier`	string	No	One of: dhl, 17track, auto. Default: “auto”
`trackingNumber`	string	Yes	Pattern: ^[A-Za-z0-9-]{6,40}$

Input JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "carrier": {
      "default": "auto",
      "type": "string",
      "enum": [
        "dhl",
        "17track",
        "auto"
      ]
    },
    "trackingNumber": {
      "type": "string",
      "pattern": "^[A-Za-z0-9-]{6,40}$"
    }
  },
  "required": [
    "trackingNumber"
  ]
}

Request the action

Prepare action.json with kind: "shipment_tracking" and an input object matching the schema above.

Replace PROJECT_ID with your saved project ID. Use a new idempotency key for new work and retain it for an identical retry.

maglev actions request PROJECT_ID --input action.json \
  --idempotency-key example-shipment-tracking-001 --json

Read action.status, action.output, deliveries and any task in the response. Model actions can take several minutes. After a timeout, check saved actions before retrying. See request and recovery behavior.

Output

The schema below describes action.output.result. The saved action.output envelope also contains draft: true and a note. It can be null while an action is running or after a failure; check the status before reading the result. Null or missing facts are unknown; preserve source references and open questions.

This action currently exports an open object schema. Inspect its returned fields and status; an open schema is not a guarantee that a particular field will exist.

Output JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}