Errors

Ordertracker uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Ordertracker's servers (these are rare).

Please make sure to set your timeout to be at least 90 seconds when making API calls.

While shipment tracking requests typically resolve within 30 seconds, it's advisable to account for a maximum of 90 seconds in case of any delays.

Common status codes

Here is a list of the different categories of status codes returned by the Ordertracker API. Use these to understand if a request was successful.

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — this means it's a you problem.

  • Name
    400
    Type
    Description

    Bad Request: Invalid tracking number format

  • Name
    401
    Type
    Description

    Unauthorized: Invalid API key

    Unauthorized: You have used all of your monthly shipments quota, please upgrade your subscription

  • Name
    429
    Type
    Description

    Too Many Requests: Too Many Requests

    For more information about this error code, please consult the rate limit section.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — this means it's an us problem (these are rare).

Error response

Whenever a request is unsuccessful, the Ordertracker API will return an error response with an error message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Example 400 Bad Request error response

{
  "error": {
    "message": "Invalid tracking number format"
  }
}