BigCommerce · Schema

address_Base

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
firstName	string
lastName	string
email	string
company	string
address1	string
address2	string
city	string
stateOrProvince	string	Represents state or province.
stateOrProvinceCode	string
countryCode	string	ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
postalCode	string
phone	string
customFields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/address_Base",
  "title": "address_Base",
  "required": [
    "countryCode"
  ],
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": ""
    },
    "lastName": {
      "type": "string",
      "description": ""
    },
    "email": {
      "type": "string",
      "description": ""
    },
    "company": {
      "type": "string",
      "description": ""
    },
    "address1": {
      "type": "string",
      "description": ""
    },
    "address2": {
      "type": "string",
      "description": ""
    },
    "city": {
      "type": "string",
      "description": ""
    },
    "stateOrProvince": {
      "type": "string",
      "description": "Represents state or province."
    },
    "stateOrProvinceCode": {
      "type": "string",
      "description": ""
    },
    "countryCode": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)"
    },
    "postalCode": {
      "type": "string",
      "description": ""
    },
    "phone": {
      "pattern": "^\\+?[1-9]\\d{1,14}(x\\d{1-5})?$",
      "type": "string",
      "description": ""
    },
    "customFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customFields"
      }
    }
  },
  "x-internal": false
}