create_manifest_response_body.json

{
  "$id": "create_manifest_response_body",
  "title": "create_manifest_response_body",
  "type": "object",
  "required": [
    "manifest_id",
    "form_id",
    "created_at",
    "ship_date",
    "shipments",
    "warehouse_id",
    "submission_id",
    "carrier_id",
    "manifest_download"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "title": "manifests",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "manifests": {
          "type": "array",
          "items": {
            "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
                          }
                        ]
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    },
    {
      "title": "manifests requests",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "manifest_requests": {
          "type": "array",
          "items": {
            "title": "manifest request",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "manifest_request_id": {
                "allOf": [
                  {
                    "title": "se_id",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 25,
                    "pattern": "^se(-[a-z0-9]+)+$"
                  }
                ]
              },
              "status": {
                "allOf": [
                  {
                    "title": "manifest_request_status",
                    "type": "string",
                    "enum": [
                      "in_progress",
                      "completed"
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    },
    {
      "title": "deprecated_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
        },
        "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
                    }
                  ]
                }
              }
            }
          ]
        },
        "label_ids": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "title": "se_id",
                "type": "string",
                "minLength": 1,
                "maxLength": 25,
                "pattern": "^se(-[a-z0-9]+)+$"
              }
            ]
          }
        }
      }
    },
    {
      "title": "error_with_label_id_response_body",
      "type": "object",
      "required": [
        "request_id",
        "errors"
      ],
      "additionalProperties": false,
      "properties": {
        "request_id": {
          "allOf": [
            {
              "title": "uuid",
              "type": "string",
              "format": "uuid",
              "minLength": 36,
              "maxLength": 36,
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
            }
          ]
        },
        "errors": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "title": "error",
                "type": "object",
                "required": [
                  "error_source",
                  "error_type",
                  "error_code",
                  "message"
                ],
                "additionalProperties": false,
                "properties": {
                  "error_source": {
                    "allOf": [
                      {
                        "title": "error_source",
                        "type": "string",
                        "enum": [
                          "carrier",
                          "order_source",
                          "shipengine"
                        ]
                      }
                    ]
                  },
                  "error_type": {
                    "allOf": [
                      {
                        "title": "error_type",
                        "type": "string",
                        "enum": [
                          "account_status",
                          "business_rules",
                          "validation",
                          "security",
                          "system",
                          "integrations"
                        ]
                      }
                    ]
                  },
                  "error_code": {
                    "allOf": [
                      {
                        "title": "error_code",
                        "type": "string",
                        "enum": [
                          "auto_fund_not_supported",
                          "batch_cannot_be_modified",
                          "carrier_conflict",
                          "carrier_disconnected",
                          "carrier_not_connected",
                          "carrier_not_supported",
                          "confirmation_not_supported",
                          "default_warehouse_cannot_be_deleted",
                          "field_conflict",
                          "field_value_required",
                          "forbidden",
                          "identifier_conflict",
                          "identifiers_must_match",
                          "insufficient_funds",
                          "invalid_address",
                          "invalid_billing_plan",
                          "invalid_field_value",
                          "invalid_identifier",
                          "invalid_status",
                          "invalid_string_length",
                          "label_images_not_supported",
                          "meter_failure",
                          "order_source_not_active",
                          "rate_limit_exceeded",
                          "refresh_not_supported",
                          "request_body_required",
                          "return_label_not_supported",
                          "settings_not_supported",
                          "subscription_inactive",
                          "terms_not_accepted",
                          "tracking_not_supported",
                          "trial_expired",
                          "unauthorized",
                          "unknown",
                          "unspecified",
                          "verification_failure",
                          "warehouse_conflict",
                          "webhook_event_type_conflict"
                        ]
                      }
                    ]
                  },
                  "message": {
                    "type": "string",
                    "minLength": 1
                  }
                }
              }
            ]
          }
        }
      }
    }
  ]
}