BigCommerce · Schema

customerAddresses_Base

The `address` object for the `customer` objectʼs `addresses` array.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
first_name	string	The first name of the customer address.
last_name	string	The last name of the customer address.
company	string	The company of the customer address.
address1	string	The address 1 line.
address2	string	The address 2 line.
city	string	The city of the customer address.
state_or_province	string	The state or province name. It is required for countries that need a state/province to complete an address.
postal_code	string	The postal code of the customer address. It is required for countries that need postal codes to complete an address.
country_code	string	The country code of the customer address.
phone	string	The phone number of the customer address.
address_type	string	The address type. Residential or Commercial.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customerAddresses_Base",
  "title": "customerAddresses_Base",
  "example": {
    "address1": "Addr 1",
    "address2": "",
    "address_type": "residential",
    "city": "San Francisco",
    "company": "History",
    "country_code": "US",
    "first_name": "Ronald",
    "last_name": "Swimmer",
    "phone": "707070707",
    "postal_code": "33333",
    "state_or_province": "California"
  },
  "type": "object",
  "properties": {
    "first_name": {
      "description": "The first name of the customer address.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "last_name": {
      "description": "The last name of the customer address.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "company": {
      "description": "The company of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 255
    },
    "address1": {
      "description": "The address 1 line.",
      "type": "string"
    },
    "address2": {
      "description": "The address 2 line.",
      "type": "string"
    },
    "city": {
      "description": "The city of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 100
    },
    "state_or_province": {
      "description": "The state or province name. It is required for countries that need a state/province to complete an address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 100
    },
    "postal_code": {
      "description": "The postal code of the customer address. It is required for countries that need postal codes to complete an address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 30
    },
    "country_code": {
      "description": "The country code of the customer address.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "phone": {
      "description": "The phone number of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 50
    },
    "address_type": {
      "title": "Address Type",
      "description": "The address type. Residential or Commercial.",
      "example": "residential",
      "type": "string",
      "enum": [
        "residential",
        "commercial"
      ]
    }
  },
  "required": [
    "first_name",
    "last_name",
    "address1",
    "city",
    "country_code"
  ],
  "description": "The `address` object for the `customer` object\u02bcs `addresses` array.",
  "x-internal": false
}