orders.shipment.track

Record a shipment status transition by hand.

Machine-readable body schema: /schemas/routes/orders.shipment.track.json.

Body

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "picked_up",
        "in_transit",
        "out_for_delivery",
        "delivered",
        "undelivered",
        "returned"
      ]
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false
}
Generated from the live platform registries at build time — reference pages cannot go stale. Markdown variant: /reference/routes/orders.shipment.track.md