Properties
| Name | Type | Description |
|---|---|---|
| address1 | string | Valid deliverable address (no PO boxes). |
| address2 | string | Unit or apartment number (if applicable). |
| city | string | Name of city. |
| country | string | Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format. |
| postal_code | string | Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4. |
| state | string | Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/address-patch",
"title": "Address",
"type": "object",
"properties": {
"address1": {
"description": "Valid deliverable address (no PO boxes).",
"example": "123 Old Forest Way",
"type": "string"
},
"address2": {
"description": "Unit or apartment number (if applicable).",
"type": "string"
},
"city": {
"description": "Name of city.",
"example": "Omaha",
"type": "string"
},
"country": {
"description": "Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format.",
"example": "USA",
"type": "string"
},
"postal_code": {
"description": "Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4.",
"example": "68022",
"type": "string"
},
"state": {
"description": "Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.",
"example": "NE",
"type": "string"
}
}
}