Skip to content

CartAddress ​

Type: schema

Description ​

A billing or shipping address set on a cart. null until an address is set.

TypeScript Definition ​

typescript
CartAddress: {{
            id: string | null;
            first_name: string;
            last_name: string | null;
            business_name: string | null;
            /** @description 10 digit phone number without country code. */
            phone: string;
            /** @description Phone country code with a plus sign prefix, e.g. `+91`. */
            country_code: string;
            email: string;
            address_line1: string;
            address_line2: string | null;
            landmark: string | null;
            pincode: string;
            city: string;
            state: string;
            /** @description `null` when the saved address it was set from has no country. */
            country: string | null;
            /** @description GST identification number of the buyer's business, when one was given with the address. */
            gstin: string | null;
            /** @description Tax Identification Number specific to the country of operation. */
            tax_identification_number: string | null;
            is_email_verified: boolean;
            is_phone_verified: boolean;
        } | null;
        /**
         * CartItem
         * @description This Cart Item model captures the attributes of a cart item, including product details, pricing information, subscription details, and other relevant information related to Cart Item.
         */
}

OpenAPI Schema ​

json
{
  "title": "CartAddress",
  "description": "A billing or shipping address set on a cart. `null` until an address is set.",
  "type": [
    "object",
    "null"
  ],
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CartAddress",
    "description": "API reference for the CartAddress schema"
  },
  "required": [
    "id",
    "first_name",
    "last_name",
    "business_name",
    "phone",
    "country_code",
    "email",
    "address_line1",
    "address_line2",
    "landmark",
    "pincode",
    "city",
    "state",
    "country",
    "gstin",
    "tax_identification_number",
    "is_email_verified",
    "is_phone_verified"
  ],
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ]
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "business_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "10 digit phone number without country code.",
      "type": "string"
    },
    "country_code": {
      "description": "Phone country code with a plus sign prefix, e.g. `+91`.",
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "address_line1": {
      "type": "string"
    },
    "address_line2": {
      "type": [
        "string",
        "null"
      ]
    },
    "landmark": {
      "type": [
        "string",
        "null"
      ]
    },
    "pincode": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "country": {
      "description": "`null` when the saved address it was set from has no country.",
      "type": [
        "string",
        "null"
      ]
    },
    "gstin": {
      "description": "GST identification number of the buyer's business, when one was given with the address.",
      "type": [
        "string",
        "null"
      ]
    },
    "tax_identification_number": {
      "description": "Tax Identification Number specific to the country of operation.",
      "type": [
        "string",
        "null"
      ]
    },
    "is_email_verified": {
      "type": "boolean"
    },
    "is_phone_verified": {
      "type": "boolean"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: