BigCommerce · Schema

Address

Requests may have partial Address data. For example, the BigCommerce Cart page has the "Estimate Shipping & Tax" feature which is only expected to supply Country, Region and Postal Code.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
line1	string	Primary street address.
line2	string	Apartment, unit, suite, building, floor, etc.
city	string	City, suburb, township, etc.
region_name	string	State, province, territory, etc.
region_code	string	If available, the short code/acronym for the region. For example, "CA" for "California" or "NSW" for "New South Wales".
country_name	string	The human-readable country name.
country_code	string	ISO 3166-1 alpha-2 format country code.
postal_code	string	Postcode, ZIP, etc. Optional.
company_name	string	If this is a commercial address, the associated company’s name.
type	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address",
  "title": "Address",
  "type": "object",
  "description": "Requests may have partial Address data. For example, the BigCommerce Cart page has the \"Estimate Shipping & Tax\" feature which is only expected to supply Country, Region and Postal Code.",
  "properties": {
    "line1": {
      "type": "string",
      "description": "Primary street address."
    },
    "line2": {
      "type": "string",
      "description": "Apartment, unit, suite, building, floor, etc."
    },
    "city": {
      "type": "string",
      "description": "City, suburb, township, etc.",
      "example": "Sydney"
    },
    "region_name": {
      "type": "string",
      "description": "State, province, territory, etc.",
      "example": "New South Wales"
    },
    "region_code": {
      "type": "string",
      "description": "If available, the short code/acronym for the region. For example, \"CA\" for \"California\" or \"NSW\" for \"New South Wales\".",
      "example": "NSW"
    },
    "country_name": {
      "type": "string",
      "example": "Australia",
      "description": "The human-readable country name."
    },
    "country_code": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 format country code.",
      "example": "AU"
    },
    "postal_code": {
      "type": "string",
      "description": "Postcode, ZIP, etc. Optional.",
      "example": "2007"
    },
    "company_name": {
      "type": "string",
      "description": "If this is a commercial address, the associated company\u2019s name.",
      "deprecated": true
    },
    "type": {
      "type": "string",
      "enum": [
        "RESIDENTIAL",
        "COMMERCIAL"
      ]
    }
  },
  "x-internal": false
}