Skip to content

ShipmentProgression

Type: schema

TypeScript Definition

typescript
ShipmentProgression: {{
            status?: components["schemas"]["ShipmentStatus"];
            is_current?: $Read<boolean>;
            is_completed?: $Read<boolean>;
            /** Format: date-time */
            completion_date?: string | null;
        };
        /** @enum {unknown} */
}

Component References

ReferenceResolves To
components["schemas"]["ShipmentStatus"]ShipmentStatus

OpenAPI Schema

json
{
  "type": "object",
  "properties": {
    "status": {
      "$ref": "#/components/schemas/ShipmentStatus"
    },
    "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: