shipengine-json-schema/responses/list_batch_errors_response_body.json

The official JSON Schemas for ShipEngine™

{
  "$id": "list_batch_errors_response_body",
  "title": "list_batch_errors_response_body",
  "type": "object",
  "required": [
    "errors",
    "links"
  ],
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "default": [],
      "items": {
        "title": "batch_response_error",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "error": {
            "type": "string",
            "minLength": 1
          },
          "shipment_id": {
            "allOf": [
              {
                "title": "se_id",
                "type": "string",
                "minLength": 1,
                "maxLength": 25,
                "pattern": "^se(-[a-z0-9]+)+$"
              }
            ]
          },
          "external_shipment_id": {
            "type": "string"
          }
        }
      }
    },
    "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
                    }
                  }
                }
              ]
            }
          }
        }
      ]
    }
  }
}