REST API - Error

When an error occurred on interaction with the web service a generic error response will be shown along with the appropiate status code.

Errors

Field	Type	Description
Error	String	Error description
Errors	Error	List of error objects

Error

Field	Type	Description
Code	String	Code of error
Type	String	Type of error
Error	String	Short error description
Description	String	Description of error

Error Response

The response format is a JSON body with a specific http status code.

{
    "error": "One or more validation errors occured.",
    "errors": [
        {
            "code": "3101",
            "type": "Validation",
            "error": "Shipment: 20002 has an invalid zip code for country NL.",
            "description": "A zip code in The Netherlands should be in the format [0000 XX] or [0000XX]."
        },
        {
            "code": "2001",
            "type": "Validation",
            "error": "Shipment 20002 has an invalid combination of package and weight.",
            "description": "Weight cannot be greater than 1000gr for package 4."
        }
    ]
}