order.shipment.track

Record a carrier state transition (webhook/poll/manual) and aggregate the order's fulfillment status.

• scope: orders:write
• storefront-visible (bumps the catalog generation): no
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "shipmentId": {
      "type": "string",
      "pattern": "^shp_[a-zA-Z0-9]{1,32}$"
    },
    "status": {
      "type": "string",
      "enum": [
        "label_ready",
        "picked_up",
        "in_transit",
        "out_for_delivery",
        "delivered",
        "undelivered",
        "returned"
      ]
    },
    "providerStatusCode": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "occurredAt": {
      "type": "string"
    }
  },
  "required": [
    "shipmentId",
    "status"
  ],
  "additionalProperties": false
}