OrderDetail

Type: schema

TypeScript Definition

OrderDetail: {{
            order_number?: string;
            /** Format: date-time */
            order_date?: string;
            /** @enum {string} */
            status?: "draft" | "awaiting_approval" | "cancelled" | "shipped" | "delivered" | "awaiting_shipment";
            /** @enum {string} */
            payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refunded";
            /** Format: date-time */
            payment_success_date?: string;
            customer_id?: string;
            customer_email?: string | null;
            customer_phone?: string | null;
            customer_note?: string | null;
            is_promotion_applied?: boolean;
            promotion_discount_amount?: number | null;
            is_coupon_applied?: boolean;
            coupon_code?: string | null;
            /** Format: double */
            coupon_discount_amount?: number | null;
            on_subscription?: boolean;
            fulfillment_type?: components["schemas"]["FulfillmentType"];
            fulfillment_preference?: components["schemas"]["FulfillmentPreference"];
            sales_channel?: {
                id?: string;
                name?: string;
                type?: string;
            };
            metadata?: {
                [key: string]: string;
            };
            /** Format: double */
            subtotal?: number;
            /** Format: double */
            subtotal_tax?: number;
            /** Format: double */
            subtotal_including_tax?: number;
            /** Format: double */
            shipping_amount?: number;
            /** Format: double */
            shipping_tax_rate?: number;
            /** Format: double */
            shipping_total_tax?: number;
            /** Format: double */
            shipping_amount_including_tax?: number;
            /** Format: double */
            total_tax?: number;
            /** Format: double */
            grand_total?: number;
            loyalty_point_redeemed?: number;
            credit_balance_used?: number;
            /** Format: double */
            to_be_paid?: number;
            loyalty_point_earned?: number;
            order_items_count?: number;
            order_items?: components["schemas"]["OrderItem"][];
            billing_address?: components["schemas"]["CustomerAddress"];
            shipping_address?: components["schemas"]["CustomerAddress"];
            currency?: {
                name?: string;
                code?: string;
                symbol?: string;
            };
            feedback?: string | null;
            allowed_actions?: string[];
            applied_coupons?: components["schemas"]["AppliedCoupon"][];
            applied_promotions?: components["schemas"]["AppliedPromotion"][];
            payments?: components["schemas"]["OrderPayment"][];
            shipments?: components["schemas"]["OrderShipment"][];
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
        };
        /** OrderItem */
}

Component References

Reference	Resolves To
components["schemas"]["FulfillmentType"]	FulfillmentType
components["schemas"]["FulfillmentPreference"]	FulfillmentPreference
components["schemas"]["OrderItem"]	OrderItem
components["schemas"]["CustomerAddress"]	CustomerAddress
components["schemas"]["AppliedCoupon"]	AppliedCoupon
components["schemas"]["AppliedPromotion"]	AppliedPromotion
components["schemas"]["OrderPayment"]	OrderPayment
components["schemas"]["OrderShipment"]	OrderShipment

OpenAPI Schema

{
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string"
    },
    "order_date": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "awaiting_approval",
        "cancelled",
        "shipped",
        "delivered",
        "awaiting_shipment"
      ]
    },
    "payment_status": {
      "type": "string",
      "enum": [
        "pending",
        "success",
        "failed",
        "partially_paid",
        "refunded"
      ]
    },
    "payment_success_date": {
      "type": "string",
      "format": "date-time"
    },
    "customer_id": {
      "type": "string"
    },
    "customer_email": {
      "type": [
        "string",
        "null"
      ]
    },
    "customer_phone": {
      "type": [
        "string",
        "null"
      ]
    },
    "customer_note": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_promotion_applied": {
      "type": "boolean"
    },
    "promotion_discount_amount": {
      "type": [
        "integer",
        "null"
      ]
    },
    "is_coupon_applied": {
      "type": "boolean"
    },
    "coupon_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "coupon_discount_amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double"
    },
    "on_subscription": {
      "type": "boolean"
    },
    "fulfillment_type": {
      "$ref": "#/components/schemas/FulfillmentType"
    },
    "fulfillment_preference": {
      "$ref": "#/components/schemas/FulfillmentPreference"
    },
    "sales_channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "subtotal": {
      "type": "number",
      "format": "double"
    },
    "subtotal_tax": {
      "type": "number",
      "format": "double"
    },
    "subtotal_including_tax": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_tax_rate": {
      "type": "number",
      "format": "double"
    },
    "shipping_total_tax": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount_including_tax": {
      "type": "number",
      "format": "double"
    },
    "total_tax": {
      "type": "number",
      "format": "double"
    },
    "grand_total": {
      "type": "number",
      "format": "double"
    },
    "loyalty_point_redeemed": {
      "type": "integer"
    },
    "credit_balance_used": {
      "type": "integer"
    },
    "to_be_paid": {
      "type": "number",
      "format": "double"
    },
    "loyalty_point_earned": {
      "type": "integer"
    },
    "order_items_count": {
      "type": "integer"
    },
    "order_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItem"
      }
    },
    "billing_address": {
      "$ref": "#/components/schemas/CustomerAddress"
    },
    "shipping_address": {
      "$ref": "#/components/schemas/CustomerAddress"
    },
    "currency": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "feedback": {
      "type": [
        "string",
        "null"
      ]
    },
    "allowed_actions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "applied_coupons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppliedCoupon"
      }
    },
    "applied_promotions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppliedPromotion"
      }
    },
    "payments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderPayment"
      }
    },
    "shipments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderShipment"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "title": "OrderDetail",
  "x-tags": [
    "Orders"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions