CustomerAddress

Type: schema

TypeScript Definition

CustomerAddress: {{
            /** @description null value for guest checkout. */
            id?: string | null;
            first_name: string;
            last_name: string | null;
            /** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
            country_code: string;
            /** @description 10 digit phone number without country code. */
            phone: string;
            email: string;
            address_line1: string;
            address_line2: string | null;
            landmark: string | null;
            pincode: string;
            city: string;
            state: string;
            /** @constant */
            country: "India";
            /**
             * @description Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
             * @example 123456789
             * @example GB123456789
             * @example IN27AAEPM0111C1ZQ
             */
            tax_identification_number: string | null;
            /** @description Use in billing & shipping details only. */
            business_name: string | null;
            readonly is_phone_verified: boolean;
            readonly is_email_verified: boolean;
        } | null;
        /** CustomerDetail */
}

OpenAPI Schema

{
  "type": [
    "object",
    "null"
  ],
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerAddress",
    "description": "API reference for the CustomerAddress schema"
  },
  "required": [
    "first_name",
    "last_name",
    "country_code",
    "phone",
    "email",
    "address_line1",
    "address_line2",
    "landmark",
    "pincode",
    "city",
    "state",
    "country",
    "tax_identification_number",
    "business_name",
    "is_phone_verified",
    "is_email_verified"
  ],
  "properties": {
    "id": {
      "description": "null value for guest checkout.",
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "country_code": {
      "description": "Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n",
      "type": "string"
    },
    "phone": {
      "description": "10 digit phone number without country code.",
      "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": {
      "type": "string",
      "const": "India"
    },
    "tax_identification_number": {
      "description": "Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.",
      "type": [
        "string",
        "null"
      ],
      "examples": [
        "123456789",
        "GB123456789",
        "IN27AAEPM0111C1ZQ"
      ]
    },
    "business_name": {
      "description": "Use in billing & shipping details only.",
      "type": [
        "string",
        "null"
      ]
    },
    "is_phone_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_email_verified": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "examples": []
}

---

Auto-generated from OpenAPI spec and TypeScript definitions