OrderShipment

Type: schema

Description

Order shipment model

TypeScript Definition

OrderShipment: {{
            reference_number?: string;
            /** @enum {string} */
            status?: "unscheduled" | "schedule_requested" | "scheduled" | "packed" | "shipped" | "in_transit" | "out_for_delivery" | "delivery_attempted" | "undelivered" | "return_to_origin" | "delivered" | "cancelled";
            total_weight?: number;
            total_boxes?: number;
            shipment_items_count?: number;
            shipment_items?: components["schemas"]["ShipmentItem"][];
            /** Format: double */
            shipping_amount?: number;
            /** Format: double */
            shipping_tax_amount?: number;
            /** Format: double */
            shipping_amount_including_tax?: number;
            courier_company_name?: string;
            shipping_label_url?: string;
            awb_no?: string;
            tracking_url?: string;
            eta_delivery?: string;
            /** Format: date-time */
            shipped_date?: string;
            /** Format: date-time */
            delivered_date?: string;
            cancellation_reason?: string;
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
        };
        /**
         * @description pagination metadata structure
         * @example {
         *       "total_records": 252,
         *       "total_pages": 26,
         *       "previous_page": null,
         *       "next_page": 2,
         *       "limit": 10
         *     }
         */
}

Component References

Reference	Resolves To
components["schemas"]["ShipmentItem"]	ShipmentItem

OpenAPI Schema

{
  "title": "OrderShipment",
  "description": "Order shipment model",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderShipment",
    "description": "API reference for the OrderShipment schema"
  },
  "properties": {
    "reference_number": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "unscheduled",
        "schedule_requested",
        "scheduled",
        "packed",
        "shipped",
        "in_transit",
        "out_for_delivery",
        "delivery_attempted",
        "undelivered",
        "return_to_origin",
        "delivered",
        "cancelled"
      ]
    },
    "total_weight": {
      "type": "number"
    },
    "total_boxes": {
      "type": "integer"
    },
    "shipment_items_count": {
      "type": "integer"
    },
    "shipment_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShipmentItem"
      }
    },
    "shipping_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_tax_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount_including_tax": {
      "type": "number",
      "format": "double"
    },
    "courier_company_name": {
      "type": "string"
    },
    "shipping_label_url": {
      "type": "string"
    },
    "awb_no": {
      "type": "string"
    },
    "tracking_url": {
      "type": "string"
    },
    "eta_delivery": {
      "type": "string"
    },
    "shipped_date": {
      "type": "string",
      "format": "date-time"
    },
    "delivered_date": {
      "type": "string",
      "format": "date-time"
    },
    "cancellation_reason": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions