Error Codes

When errors occur, ShipEngine gives you the information you need to successfully handle the error and resolve the problem. This page lists all the different error_source, error_type, and error_code values that you might get from ShipEngine and how to handle them.

Before reading this page, you should first have an understanding of how ShipEngine communicates errors and how you should handle them. See the error handling guide to learn more.

Error Structure

Each error object inside the errors array has the following structure:

Example Error

Here's an example of an error object. Notice that it has all the error fields plus some error-specific fields like confirmation, carrier_id, carrier_code, and carrier_name.

1
2
3
4
5
6
7
8
9
10
{
  "error_source": "shipengine",
  "error_type": "business_rules",
  "error_code": "confirmation_not_supported",
  "message": "Adult signature confirmation is not supported by Australia Post.",
  "confirmation": "adult_signature",
  "carrier_id": "se-123456",
  "carrier_code": "australia_post",
  "carrier_name": "Australia Post"
}

Error Source

The error_source field indicates where the error originated. This lets you know whether you should contact ShipEngine for support or if you should contact the carrier or marketplace instead.

Error Type

The error_type field indicates the type of error that occurred. Think of this as a broad category of error.

This field makes it easier to handle all errors of a certain type the same way. For example, you may choose to prompt the user whenever a validation error occurs and you may choose to email your IT admins when a security error occurs.

Error Code

The error_code indicates the specific error that occurred. You can use this field to write code that handles a specific error however you want. If you'd rather handle all errors of a certain type the same way, consider using the error_type field instead.