CustomerAddress

Type: schema

TypeScript Definition

CustomerAddress: {{
            readonly id?: string;
            first_name: string;
            last_name?: string;
            /** @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;
            /** @enum {unknown} */
            country: "India";
            /** @description Use in shipping details only for third party. */
            gstin?: string | null;
            /** @description Use in shipping details only for third party. */
            business_name?: string | null;
            readonly is_phone_verified?: boolean;
            readonly is_email_verified?: boolean;
        };
        /** CustomerDetail */
}

OpenAPI Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "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": {
      "enum": [
        "India"
      ]
    },
    "gstin": {
      "description": "Use in shipping details only for third party.",
      "type": [
        "string",
        "null"
      ]
    },
    "business_name": {
      "description": "Use in shipping details only for third party.",
      "type": [
        "string",
        "null"
      ]
    },
    "is_phone_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_email_verified": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "examples": [],
  "required": [
    "first_name",
    "phone",
    "email",
    "address_line1",
    "pincode",
    "city",
    "state",
    "country"
  ],
  "title": "CustomerAddress",
  "x-tags": [
    "Customers"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions