shipengine-json-schema

{ "$id": "list_batches_response_body", "title": "list_batches_response_body", "type": "object", "required": [ "batches", "total", "page", "pages", "links" ], "additionalProperties": false, "properties": { "batches": { "type": "array", "minItems": 0, "items": { "allOf": [ { "title": "batch", "type": "object", "required": [ "label_layout", "label_format", "batch_id", "batch_number", "external_batch_id", "batch_notes", "created_at", "processed_at", "errors", "warnings", "completed", "forms", "count", "batch_shipments_url", "batch_labels_url", "batch_errors_url", "label_download", "form_download", "status" ], "additionalProperties": false, "properties": { "label_layout": { "default": "4x6", "allOf": [ { "title": "label_layout", "type": "string", "enum": [ "4x6", "letter" ] } ] }, "label_format": { "default": "pdf", "allOf": [ { "title": "label_format", "type": "string", "enum": [ "pdf", "png", "zpl" ] } ] }, "batch_id": { "allOf": [ { "title": "se_id", "type": "string", "minLength": 1, "maxLength": 25, "pattern": "^se(-[a-z0-9]+)+$" } ] }, "batch_number": { "type": "string", "minLength": 0 }, "external_batch_id": { "type": "string", "minLength": 0 }, "batch_notes": { "type": "string", "default": "" }, "created_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})$" } ] }, "processed_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})$" } ] }, "errors": { "type": "integer", "format": "int32", "minimum": 0 }, "warnings": { "type": "integer", "format": "int32", "minimum": 0 }, "completed": { "type": "integer", "format": "int32", "minimum": 0 }, "forms": { "type": "integer", "format": "int32", "minimum": 0 }, "count": { "type": "integer", "format": "int32", "minimum": 0 }, "batch_shipments_url": { "allOf": [ { "title": "optional_link", "type": "object", "additionalProperties": false, "properties": { "href": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "type": { "type": "string", "minLength": 1 } } } ] }, "batch_labels_url": { "allOf": [ { "title": "optional_link", "type": "object", "additionalProperties": false, "properties": { "href": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "type": { "type": "string", "minLength": 1 } } } ] }, "batch_errors_url": { "allOf": [ { "title": "optional_link", "type": "object", "additionalProperties": false, "properties": { "href": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "type": { "type": "string", "minLength": 1 } } } ] }, "label_download": { "allOf": [ { "title": "label_download", "type": "object", "additionalProperties": false, "properties": { "href": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "pdf": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "png": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "zpl": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] } } } ] }, "form_download": { "allOf": [ { "title": "optional_link", "type": "object", "additionalProperties": false, "properties": { "href": { "allOf": [ { "title": "url", "type": "string", "format": "url", "minLength": 1 } ] }, "type": { "type": "string", "minLength": 1 } } } ] }, "status": { "allOf": [ { "title": "batch_status", "type": "string", "enum": [ "open", "queued", "processing", "completed", "completed_with_errors", "archived", "notifying", "invalid" ] } ] } } } ] } }, "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 } } } ] } } } ] } } }