CartShipment

Type: schema

Description

Cart shipment model

TypeScript Definition

CartShipment: {{
            id?: string;
            shipping_provider_id?: string;
            shipping_provider_name?: string;
            courier_company_id?: string | null;
            courier_company_name?: string | null;
            /** Format: double */
            shipping_amount?: number;
            /** Format: double */
            shipping_tax_amount?: number;
            /** Format: double */
            shipping_amount_including_tax?: number;
            shipment_items_count?: number;
            shipment_items?: components["schemas"]["ShipmentItem"][];
        };
        /** Category */
}

Component References

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

OpenAPI Schema

{
  "title": "CartShipment",
  "description": "Cart shipment model",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CartShipment",
    "description": "API reference for the CartShipment schema"
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "shipping_provider_id": {
      "type": "string"
    },
    "shipping_provider_name": {
      "type": "string"
    },
    "courier_company_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_company_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_tax_amount": {
      "type": "number",
      "format": "double"
    },
    "shipping_amount_including_tax": {
      "type": "number",
      "format": "double"
    },
    "shipment_items_count": {
      "type": "integer"
    },
    "shipment_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ShipmentItem"
      }
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions