Ordoro · Schema
Address Schema
Order ManagementInventory ManagementShippingDropshippingEcommerceMulti-ChannelFulfillmentLogistics
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | |
| name | object | |
| company | object | |
| street1 | object | |
| street2 | object | |
| city | object | |
| state | object | |
| zip | object | |
| country | object | |
| object | ||
| phone | object | |
| fax | object | |
| cart_address_id | object | |
| revision_locked_fields | array | |
| validation | object |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/json-schema/ordoro-address-schema.json",
"title": "Address Schema",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"name": {
"example": "Jimmy McGill",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"company": {
"example": "Hamlin, Hamlin & McGill",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street1": {
"example": "100 Constitution Ave",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"city": {
"example": "Albuquerque",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"example": "NM",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"zip": {
"example": "87109",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"country": {
"example": "US",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"email": {
"example": "[email protected]",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"example": "555-867-5309",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cart_address_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"revision_locked_fields": {
"type": "array"
},
"validation": {
"title": "Validation status of an Address",
"properties": {
"status": {
"type": "string",
"enum": [
"unvalidated",
"validated",
"warning",
"error"
]
},
"suggested": {
"type": "array",
"items": {
"title": "Suggested Address",
"type": "object",
"additionalProperties": false,
"properties": {
"is_commercial": {
"default": false,
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"street1": {
"type": "string"
},
"street2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"country_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"city",
"state",
"zip",
"street1"
]
}
},
"additional_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"additional_text",
"suggested"
],
"additionalProperties": false,
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"zip",
"country",
"email",
"phone"
]
}