Skip to content

ShipmentProgression ​

Type: schema

TypeScript Definition ​

typescript
ShipmentProgression: {{
            status?: components["schemas"]["ShipmentProgressionStatus"];
            is_current?: $Read<boolean>;
            is_completed?: $Read<boolean>;
            /** Format: date-time */
            completion_date?: string | null;
        };
        /**
         * ShipmentProgressionStatus
         * @description Milestone on a shipment's fixed four-step progression ladder. Display labels, not `ShipmentStatus` values: every shipment carries all four in this order, and `is_completed` / `is_current` say where it has reached.
         * @enum {string}
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["ShipmentProgressionStatus"]ShipmentProgressionStatus

OpenAPI Schema ​

json
{
  "type": "object",
  "properties": {
    "status": {
      "$ref": "#/components/schemas/ShipmentProgressionStatus"
    },
    "is_current": {
      "type": "boolean",
      "readOnly": true
    },
    "is_completed": {
      "type": "boolean",
      "readOnly": true
    },
    "completion_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "title": "ShipmentProgression",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: