ShipmentDetail

Type: schema

TypeScript Definition

ShipmentDetail: {{
            order_number: string;
            /** Format: date-time */
            order_date: string;
            order_status: string;
            sales_channel: {
                id: string;
                name: string;
                type: string;
            };
            payment_status: components["schemas"]["PaymentStatus"];
            customer_name?: string | null;
            shipment_detail: components["schemas"]["Shipment"];
            allowed_actions: components["schemas"]["ShipmentAction"][];
        };
        /** ShipmentInfo */
}

Component References

Reference	Resolves To
components["schemas"]["PaymentStatus"]	PaymentStatus
components["schemas"]["Shipment"]	Shipment
components["schemas"]["ShipmentAction"]	ShipmentAction

OpenAPI Schema

{
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string"
    },
    "order_date": {
      "type": "string",
      "format": "date-time"
    },
    "order_status": {
      "type": "string"
    },
    "sales_channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "type"
      ]
    },
    "payment_status": {
      "$ref": "#/components/schemas/PaymentStatus"
    },
    "customer_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipment_detail": {
      "$ref": "#/components/schemas/Shipment"
    },
    "allowed_actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShipmentAction"
      }
    }
  },
  "required": [
    "order_number",
    "order_date",
    "order_status",
    "sales_channel",
    "payment_status",
    "shipment_detail",
    "allowed_actions"
  ],
  "title": "ShipmentDetail"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions