Codat · Schema

Commerce: Address

Unified_API

Properties

Name	Type	Description
type	object
line1	string	The first line of the address
line2	string	The second line of the address
city	string	The third line of the address, or city
region	string	The fourth line of the address, or region
country	string	The country for the address
postalCode	string	The postal (or zip) code for the address

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CommerceAddress",
  "title": "Commerce: Address",
  "x-internal": true,
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CommerceAddress/definitions/commerceAddressType"
    },
    "line1": {
      "description": "The first line of the address",
      "type": "string"
    },
    "line2": {
      "description": "The second line of the address",
      "type": "string"
    },
    "city": {
      "description": "The third line of the address, or city",
      "type": "string"
    },
    "region": {
      "description": "The fourth line of the address, or region",
      "type": "string"
    },
    "country": {
      "description": "The country for the address",
      "type": "string"
    },
    "postalCode": {
      "description": "The postal (or zip) code for the address",
      "type": "string"
    }
  },
  "definitions": {
    "commerceAddressType": {
      "description": "The type of the address",
      "type": "string",
      "enum": [
        "Billing",
        "Delivery",
        "Order",
        "Inventory",
        "Unknown"
      ]
    }
  }
}