Error Codes & Handling

Error Handling in CargoFP API

All errors from the CargoFP API follow a standard JSON structure. Errors are grouped into Validation Errors, Client Errors, and Server Errors.

Error Response Structure

{
  "type": "<error_type>",
  "errors": [
    {
      "code": "<error_code>",
      "detail": "<error_description>",
      "attr": "<request_attribute>"
    }
  ]
}

• type can be validation_error, client_error, or server_error
• errors is an array of error objects
• code is a short error identifier
• detail is a descriptive message
• attr is the field associated with the error (or non_field_errors for global issues)

Example: Unknown Port

{
  "type": "validation_error",
  "errors": [
    {
      "code": "unknown_port",
      "detail": "Port is unknown.",
      "attr": "departure_port"
    }
  ]
}

Error Types & Details

Validation Errors

Client Errors

Server Errors