shipengine-json-schema
Version:
The official JSON Schemas for ShipEngine™
125 lines • 3.89 kB
JSON
{
"title": "500_error_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
}
}
}
]
}
}
},
"$id": "500_error_response_body"
}