shipengine-json-schema
Version:
The official JSON Schemas for ShipEngine™
241 lines • 6.59 kB
JSON
{
"$id": "get_tracking_log_from_label_response_body",
"title": "get_tracking_log_from_label_response_body",
"type": "object",
"required": [
"tracking_number",
"status_code",
"carrier_status_code",
"estimated_delivery_date",
"events"
],
"additionalProperties": false,
"allOf": [
{
"title": "tracking_information",
"type": "object",
"additionalProperties": false,
"properties": {
"tracking_number": {
"allOf": [
{
"title": "tracking_number",
"type": "string",
"minLength": 1
}
]
},
"tracking_url": {
"type": "string"
},
"status_code": {
"allOf": [
{
"title": "status_code",
"enum": [
"un",
"ac",
"it",
"de",
"ex",
"at",
"ny"
],
"type": "string"
}
]
},
"carrier_code": {
"allOf": [
{
"title": "carrier_code",
"type": "string",
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
}
]
},
"carrier_id": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
},
"status_description": {
"type": "string",
"minLength": 0
},
"carrier_status_code": {
"type": "string",
"minLength": 1
},
"carrier_detail_code": {
"type": "string",
"minLength": 1
},
"carrier_status_description": {
"type": "string",
"minLength": 0
},
"ship_date": {
"allOf": [
{
"title": "date_time",
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$"
}
]
},
"estimated_delivery_date": {
"allOf": [
{
"title": "date_time",
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$"
}
]
},
"actual_delivery_date": {
"allOf": [
{
"title": "date_time",
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$"
}
]
},
"exception_description": {
"type": "string",
"minLength": 0
},
"events": {
"type": "array",
"items": {
"title": "track_event",
"type": "object",
"required": [
"occurred_at",
"city_locality",
"state_province",
"postal_code",
"carrier_detail_code",
"status_code",
"status_description",
"carrier_status_code",
"carrier_status_description"
],
"additionalProperties": false,
"properties": {
"occurred_at": {
"allOf": [
{
"title": "date_time",
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$"
}
]
},
"carrier_occurred_at": {
"allOf": [
{
"title": "date_time",
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$"
}
]
},
"city_locality": {
"type": "string",
"minLength": 0
},
"state_province": {
"type": "string",
"minLength": 2
},
"postal_code": {
"type": "string",
"minLength": 0
},
"country_code": {
"allOf": [
{
"title": "country_code",
"type": "string",
"minLength": 2,
"maxLength": 2
}
]
},
"company_name": {
"type": "string",
"minLength": 0
},
"signer": {
"type": "string",
"minLength": 0
},
"event_code": {
"type": "string",
"minLength": 0
},
"carrier_detail_code": {
"type": "string",
"minLength": 1
},
"status_code": {
"allOf": [
{
"title": "status_code",
"enum": [
"un",
"ac",
"it",
"de",
"ex",
"at",
"ny"
],
"type": "string"
}
]
},
"status_description": {
"type": "string",
"minLength": 1
},
"carrier_status_code": {
"type": "string",
"minLength": 1
},
"carrier_status_description": {
"type": "string",
"minLength": 0
},
"latitude": {
"type": "number",
"format": "double",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"format": "double",
"minimum": -180,
"maximum": 180
}
}
}
}
}
}
]
}