DeliveryOption

Type: schema

TypeScript Definition

DeliveryOption: {{
            is_serviceable: boolean;
            /** @description free shipping threshold of delivery option */
            free_shipping_threshold: number | null;
            shipments: {
                id: string;
                items: components["schemas"]["ShipmentItem"][];
                shipping_methods: {
                    id?: string;
                    name?: string;
                    /** @enum {unknown} */
                    shipping_type?: "auto" | "manual";
                    /** @description shipping amount of manual method or as per recommened courier or range of min-max shipping amount. */
                    shipping_amount?: string;
                    /** @description estimated delivery days of manual method or as per recommened courier or range of min-max estimated delivery days. */
                    estimated_delivery_days?: string;
                    courier_companies?: {
                        id?: string | number;
                        name?: string;
                        shipping_amount?: number;
                        estimated_delivery_days?: string;
                        is_recommended?: boolean;
                        is_hyperlocal?: boolean;
                        /** @enum {unknown} */
                        mode?: "air" | "surface";
                        rating?: number;
                    }[];
                }[];
            }[];
        };
        /** DiscountBasedPromotion */
}

Component References

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

OpenAPI Schema

{
  "title": "DeliveryOption",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/DeliveryOption",
    "description": "API reference for the DeliveryOption schema"
  },
  "required": [
    "is_serviceable",
    "free_shipping_threshold",
    "shipments"
  ],
  "properties": {
    "is_serviceable": {
      "type": "boolean"
    },
    "free_shipping_threshold": {
      "description": "free shipping threshold of delivery option",
      "type": [
        "number",
        "null"
      ]
    },
    "shipments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentItem"
            }
          },
          "shipping_methods": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "shipping_type": {
                  "enum": [
                    "auto",
                    "manual"
                  ]
                },
                "shipping_amount": {
                  "description": "shipping amount of manual method or as per recommened courier or range of min-max shipping amount.",
                  "type": "string"
                },
                "estimated_delivery_days": {
                  "description": "estimated delivery days of manual method or as per recommened courier or range of min-max estimated delivery days.",
                  "type": "string"
                },
                "courier_companies": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": [
                          "string",
                          "number"
                        ]
                      },
                      "name": {
                        "type": "string"
                      },
                      "shipping_amount": {
                        "type": "number"
                      },
                      "estimated_delivery_days": {
                        "type": "string"
                      },
                      "is_recommended": {
                        "type": "boolean"
                      },
                      "is_hyperlocal": {
                        "type": "boolean"
                      },
                      "mode": {
                        "enum": [
                          "air",
                          "surface"
                        ]
                      },
                      "rating": {
                        "type": "number"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "required": [
          "id",
          "items",
          "shipping_methods"
        ]
      }
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions