Errors

Overview

HTTP Status Codes

200s status codes

HTTP Status Code	Description
200 OK	Request has been fulfilled.
201 Created	Request has been fulfilled and new resource created.
204 No Content	There is no content for a successful request.
206 Partial Content	Request has been fulfilled for the partial content requested.

300s status codes

HTTP Status Code	Description
302 IDP Redirect / Callback	Indicates redirect or callback to destination.

400s status codes

HTTP Status Code	Examples
400 Bad Request	e.g. missing or invalid access token, or incorrect Basic Auth credentials for login endpoint.
401 Unauthorized	No or invalid access token.
403 Forbidden	e.g. incorrect current password provided for password change endpoint or Incorrect user password for login endpoint.
404 Not Found	Requested resource doesn't exist e.g. Invalid username or password combination
408 Request Timeout	The client failed to complete the request within a certain timeframe.
406 Not Acceptable	e.g. Password reset link is expired or already used for password reset endpoint.
409 Conflict	Requested resource could not be processed because of a conflict e.g. user is already registered for registration endpoint
412 Precondition Failed	Preconditions were not met.
413 Payload Too Large	The request entity is larger than limits defined by server.
422 Invalid Data Sent	Unprocessable entity e.g. Application does not exist or shop_id is invalid or Invalid JSON schema (e.g., expired JWT for `idPRedirect` or email format validation failure during login flow.
424 Failed Dependency	Request failed due to a failure of dependency.
429 Too Many Request	e.g. Rate limit exceeded; too many requests in a short period

HTTP status code	Description
500 Internal Server Error	Unexpected error on Storefront API server.
502 Bad Gateway	Server got an invalid response.
503 Service Unavailable	Service unavailable due to internal errors.
504 Gateway Timeout	The server took too long to respond.

Complete list of HTTP status codes.

Unauthorized client

Examples

{
  "error": "INVALID_CLIENT",
  "message": "Client authentication failed.",
  "context": null
}

Schema

error	Required `string` A key that describes the occurred error.
error_description	`string` Some human readable description of the error.
hint	`string` Hint of what caused the error.
message	`string` Additional message.
context	`object`

Unsupported grant type

{
  "error": "unsupported_grant_type",
  "error_description": "The authorization grant type is not supported by the authorization server.",
  "hint": "Check that all required parameters have been provided",
  "message": "The authorization grant type is not supported by the authorization server."
}

Invalid token response

{
  "error": "invalid_request",
  "error_description": "The refresh token is invalid.",
  "hint": "Token has been revoked",
  "message": "The refresh token is invalid."
}