Request Errors

In the event of API request errors, AfterShip uses conventional HTTP response codes in the 4XX and 5XX range to indicate the reason behind the error along with the error code already defined in the response body.

In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error caused by the given information (E.g., you omitted a required parameter or a charge failed), and codes in the 5xx range indicate an error related to AfterShip’s servers.

HTTP Status Codemeta.codemeta.typeSample Error Message
40040000BadRequestThe request body is an invalid JSON.
40040001MissingParameterRequest missing required parameters.
401401UnauthorizedThe API key is invalid.
40340300ForbiddenThe request is understood, but it has been refused or access is not allowed.
40440400NotFoundThe URI requested is invalid or the resource requested does not exist.
40940900ConflictThe request conflicts with another request (perhaps due to using the same idempotent key).
41241201PreconditionFailedPrecondition failed, header as-store-id or Date has empty value.
41241202PreconditionFailedPrecondition failed, the connection not found.
41241203PreconditionFailedPrecondition failed, a private connected app should config which automizely product can access your data firstly.
41241204PreconditionFailedPrecondition failed, the store not found.
42242200UnprocessableEntityThe request body was well-formed but contains semantical errors. The response body will provide more details in the errors or error parameters.
42942900TooManyRequestsThe request was not accepted because the application has exceeded the rate limit. The default API call limit is 10 requests per second.
50050000InternalErrorSomething went wrong on Automizely's end. Also, some error that cannot be retried happened on an external system that this call relies on.