BigCommerce · Schema

countriesState_Full

Refers to the state returned in `GET` states requests.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	integer	Numeric ID of the state/province.
state	string	Name of the state/province.
state_abbreviation	string	Abbreviation for the state/province.
country_id	integer	Numeric ID of the state’s/province’s associated country.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/countriesState_Full",
  "title": "countriesState_Full",
  "example": {
    "id": 208,
    "state": "Australian Capital Territory",
    "state_abbreviation": "ACT",
    "country_id": 13
  },
  "type": "object",
  "properties": {
    "id": {
      "description": "Numeric ID of the state/province.",
      "example": 208,
      "type": "integer"
    },
    "state": {
      "description": "Name of the state/province.",
      "example": "Australian Capital Territory",
      "type": "string"
    },
    "state_abbreviation": {
      "description": "Abbreviation for the state/province.",
      "example": "ACT",
      "type": "string"
    },
    "country_id": {
      "description": "Numeric ID of the state\u2019s/province\u2019s associated country.",
      "example": 13,
      "type": "integer"
    }
  },
  "description": "Refers to the state returned in `GET` states requests. ",
  "x-internal": false
}