shipengine-json-schema
Version:
The official JSON Schemas for ShipEngine™
280 lines • 7.92 kB
JSON
{
"$id": "list_manifests_response_body",
"title": "list_manifests_response_body",
"type": "object",
"required": [
"manifests",
"total",
"page",
"pages",
"links"
],
"additionalProperties": false,
"properties": {
"manifests": {
"type": "array",
"default": [],
"items": {
"allOf": [
{
"title": "manifest",
"type": "object",
"additionalProperties": false,
"properties": {
"manifest_id": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
},
"form_id": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"minLength": 1
},
"ship_date": {
"type": "string",
"format": "date-time",
"minLength": 1
},
"shipments": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"label_ids": {
"type": "array",
"items": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
}
},
"warehouse_id": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
},
"submission_id": {
"type": "string",
"minLength": 1
},
"carrier_id": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
},
"manifest_download": {
"allOf": [
{
"title": "manifest_download",
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"allOf": [
{
"title": "url",
"type": "string",
"format": "url",
"minLength": 1
}
]
}
}
}
]
}
}
}
]
}
},
"total": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"page": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"pages": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"links": {
"allOf": [
{
"title": "pagination_link",
"type": "object",
"required": [
"first",
"last",
"prev",
"next"
],
"additionalProperties": false,
"properties": {
"first": {
"allOf": [
{
"title": "link",
"type": "object",
"additionalProperties": false,
"required": [
"href"
],
"allOf": [
{
"title": "optional_link",
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"allOf": [
{
"title": "url",
"type": "string",
"format": "url",
"minLength": 1
}
]
},
"type": {
"type": "string",
"minLength": 1
}
}
}
]
}
]
},
"last": {
"allOf": [
{
"title": "link",
"type": "object",
"additionalProperties": false,
"required": [
"href"
],
"allOf": [
{
"title": "optional_link",
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"allOf": [
{
"title": "url",
"type": "string",
"format": "url",
"minLength": 1
}
]
},
"type": {
"type": "string",
"minLength": 1
}
}
}
]
}
]
},
"prev": {
"allOf": [
{
"title": "optional_link",
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"allOf": [
{
"title": "url",
"type": "string",
"format": "url",
"minLength": 1
}
]
},
"type": {
"type": "string",
"minLength": 1
}
}
}
]
},
"next": {
"allOf": [
{
"title": "optional_link",
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"allOf": [
{
"title": "url",
"type": "string",
"format": "url",
"minLength": 1
}
]
},
"type": {
"type": "string",
"minLength": 1
}
}
}
]
}
}
}
]
}
}
}