Shipment Error Codes

  • Ship
  • api
  • errors

Errors in Ship can have many causes, such as badly-formed requests, incorrect permissions, or unforeseen issues during request processing. This section provides an explanation of the Ship API error object and a reference list of the errors that Ship can return.

Error Structure in PRO

Errors codes in Ship have two levels - a top-level code corresponding to standard HTTP error codes and a "child" code giving more detail on the specifics of the problem.

Note

For a detailed breakdown of the error codes that Ship can return, see the List of Error Codes section.

When an API request encounters an error, Ship returns an API Error object. The API Error object contains the following information:

  • correlation_id - A unique reference for the error.
  • code - The top-level error code.
  • message - A plain-text message explaining the top-level error code returned.
  • details - An object indicating the affected shipment property (where applicable), child error code, and an explanatory message.
  • links - Links to relevant resources.
Note

The explanatory message properties should not be considered part of Ship's data contract and no logic should be programmed against them, as they are subject to change at any time.

Example API Error Object

{
  "correlation_id": "6c4e6a77-feab-42ab-9d7b-f559dc1b90ca",
  "code": "validation_error",
  "message": "A provided property has an invalid format",
  "details": [
    {
      "property": "addresses[0].contact.contact_details.email",
      "code": "invalid_format",
      "message": "'test@something' is not a valid email address"
    }
  ],
  "_links": null
}

List of Error Codes

Ship can return the following error codes:

531

521

500

429

410

405

404

401

400

Status Code Error