BigCommerce · Schema

Address Properties

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name	Type	Description
first_name	string
last_name	string
email	string
company	string
address1	string
address2	string
city	string
state_or_province	string	Represents state or province.
state_or_province_code	string
country_code	string
postal_code	string
phone	string
custom_fields	array	You can retrieve custom fields from the [Get Form Fields](/docs/rest-storefront/forms#get-form-fields) endpoint.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddressProperties",
  "title": "Address Properties",
  "required": [
    "country_code",
    "email"
  ],
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": ""
    },
    "last_name": {
      "type": "string",
      "description": ""
    },
    "email": {
      "type": "string",
      "description": ""
    },
    "company": {
      "type": "string",
      "description": ""
    },
    "address1": {
      "type": "string",
      "description": ""
    },
    "address2": {
      "type": "string",
      "description": ""
    },
    "city": {
      "type": "string",
      "description": ""
    },
    "state_or_province": {
      "type": "string",
      "description": "Represents state or province."
    },
    "state_or_province_code": {
      "type": "string",
      "description": ""
    },
    "country_code": {
      "type": "string",
      "description": ""
    },
    "postal_code": {
      "type": "string",
      "description": ""
    },
    "phone": {
      "pattern": "^\\+?[1-9]\\d{1,14}(x\\d{1-5})?$",
      "type": "string",
      "description": ""
    },
    "custom_fields": {
      "type": "array",
      "description": "You can retrieve custom fields from the [Get Form Fields](/docs/rest-storefront/forms#get-form-fields) endpoint.",
      "items": {
        "title": "Custom Field",
        "type": "object",
        "properties": {
          "field_id": {
            "type": "string",
            "description": ""
          },
          "field_value": {
            "type": "string",
            "description": "This can also be an array for fields that need to support a list of values (e.g., a set of check boxes.)"
          }
        }
      }
    }
  },
  "x-internal": false
}