CustomerAddress
Type: schema
TypeScript Definition
typescript
CustomerAddress: {{
id?: $Read<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 specific to the country of operation. */
tax_identification_number: string | null;
/** @description Use in billing & shipping details only. */
business_name: string | null;
/** @description Indicates if the address is the default billing address for the customer. */
is_default_billing?: boolean;
/** @description Indicates if the address is the default shipping address for the customer. */
is_default_shipping?: boolean;
is_phone_verified: $Read<boolean>;
is_email_verified: $Read<boolean>;
/**
* @description Nickname for the address.
* @default null
*/
nickname: string | null;
/**
* Format: date-time
* @description Creation timestamp (ISO-8601).
*/
created_at: $Read<string>;
/**
* Format: date-time
* @description Last-modification timestamp (ISO-8601).
*/
modified_at: $Read<string>;
} | null;
/**
* CustomerAttributeKind
* @description Who sets the attribute's values. `custom`: the store's own attribute, set by admins and, unless it is `is_readonly`, by shoppers in the storefront. `linked`: set from the customer's KYC document of the same type: the document number once it is approved, otherwise `not_submitted`, `submitted` or `rejected`. `system`: set by Commerce Engine, such as the campaign source of a shopper's first and latest visits (`initial-utm-source`, `utm-source`).
* @enum {string}
*/
}OpenAPI Schema
json
{
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"string",
"null"
],
"pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$",
"readOnly": true
},
"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 specific to the country of operation.",
"type": [
"string",
"null"
],
"examples": []
},
"business_name": {
"description": "Use in billing & shipping details only.",
"type": [
"string",
"null"
]
},
"is_default_billing": {
"description": "Indicates if the address is the default billing address for the customer.",
"type": "boolean"
},
"is_default_shipping": {
"description": "Indicates if the address is the default shipping address for the customer.",
"type": "boolean"
},
"is_phone_verified": {
"type": "boolean",
"readOnly": true
},
"is_email_verified": {
"type": "boolean",
"readOnly": true
},
"nickname": {
"description": "Nickname for the address.",
"type": [
"string",
"null"
],
"default": null
},
"created_at": {
"description": "Creation timestamp (ISO-8601).",
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"description": "Last-modification timestamp (ISO-8601).",
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"examples": [],
"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",
"created_at",
"modified_at"
],
"title": "CustomerAddress"
}Auto-generated from OpenAPI spec and TypeScript definitions