{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Address",
"title": "Address",
"type": "object",
"x-apideck-schema-id": "Address",
"additionalProperties": false,
"x-apideck-weights": {
"id": "edge-case",
"name": "edge-case",
"type": "critical",
"line1": "high",
"line2": "low",
"line3": "edge-case",
"line4": "edge-case",
"line5": "edge-case",
"street_number": "low",
"city": "high",
"string": "low",
"state": "high",
"postal_code": "high",
"country": "high",
"latitude": "low",
"longitude": "low",
"county": "edge-case",
"contact_name": "edge-case",
"salutation": "edge-case",
"phone_number": "edge-case",
"fax": "edge-case",
"email": "edge-case",
"website": "edge-case",
"row_version": "edge-case"
},
"properties": {
"id": {
"description": "Unique identifier for the address.",
"type": "string",
"example": "123",
"nullable": true
},
"type": {
"type": "string",
"description": "The type of address.",
"x-apideck-enum-id": "addresses.type",
"enum": [
"primary",
"secondary",
"home",
"office",
"shipping",
"billing",
"work",
"other"
],
"example": "primary",
"nullable": true
},
"string": {
"type": "string",
"description": "The address string. Some APIs don't provide structured address data.",
"example": "25 Spring Street, Blackburn, VIC 3130",
"nullable": true
},
"name": {
"description": "The name of the address.",
"type": "string",
"example": "HQ US",
"nullable": true
},
"line1": {
"type": "string",
"example": "Main street",
"description": "Line 1 of the address e.g. number, street, suite, apt #, etc.",
"nullable": true
},
"line2": {
"type": "string",
"example": "apt #",
"description": "Line 2 of the address",
"nullable": true
},
"line3": {
"type": "string",
"example": "Suite #",
"description": "Line 3 of the address",
"nullable": true
},
"line4": {
"type": "string",
"example": "delivery instructions",
"description": "Line 4 of the address",
"nullable": true
},
"line5": {
"type": "string",
"example": "Attention: Finance Dept",
"description": "Line 5 of the address",
"nullable": true
},
"street_number": {
"type": "string",
"example": "25",
"description": "Street number",
"nullable": true
},
"city": {
"type": "string",
"example": "San Francisco",
"description": "Name of city.",
"nullable": true
},
"state": {
"type": "string",
"example": "CA",
"description": "Name of state",
"nullable": true
},
"postal_code": {
"type": "string",
"example": "94104",
"description": "Zip code or equivalent.",
"nullable": true
},
"country": {
"type": "string",
"example": "US",
"description": "country code according to ISO 3166-1 alpha-2.",
"nullable": true
},
"latitude": {
"description": "Latitude of the address",
"type": "string",
"example": "40.759211",
"nullable": true
},
"longitude": {
"description": "Longitude of the address",
"type": "string",
"example": "-73.984638",
"nullable": true
},
"county": {
"type": "string",
"example": "Santa Clara",
"description": "Address field that holds a sublocality, such as a county",
"nullable": true
},
"contact_name": {
"description": "Name of the contact person at the address",
"type": "string",
"example": "Elon Musk",
"nullable": true
},
"salutation": {
"description": "Salutation of the contact person at the address",
"type": "string",
"example": "Mr",
"nullable": true
},
"phone_number": {
"description": "Phone number of the address",
"type": "string",
"example": "111-111-1111",
"nullable": true
},
"fax": {
"description": "Fax number of the address",
"type": "string",
"example": "122-111-1111",
"nullable": true
},
"email": {
"description": "Email address of the address",
"type": "string",
"example": "[email protected]",
"nullable": true
},
"website": {
"description": "Website of the address",
"type": "string",
"example": "https://elonmusk.com",
"nullable": true
},
"notes": {
"description": "Additional notes",
"type": "string",
"title": "Notes",
"example": "Address notes or delivery instructions.",
"nullable": true
},
"row_version": {
"$ref": "#/components/schemas/RowVersion"
}
}
}