HTTP status codes

HTTP status codes are an essential part of the SHOPLINE API. For every API request, the response includes an HTTP status code indicating the outcome of the request.

Status code overview​

Classes​

HTTP status codes consist of three digits, with the first digit defining the status code class.

The SHOPLINE API uses the following status code classes:

• 2xx: Success. The server has received, understood, and accepted the request.
• 3xx: Redirection. The client must take further action, such as redirecting to a new URL, to fulfill the request.
• 4xx: Client error. The request cannot be processed, typically due to client-side issues such as invalid parameter formatting, authentication failure, or resource not found.
• 5xx: Server error. The request itself is valid, but the SHOPLINE server encountered an exception. This is usually a temporary issue. Try again later or contact technical support.

Error responses​

When an API request fails, in addition to an HTTP status code (4xx or 5xx), the API includes error details in the response. The response structure is as follows:

• HTTP status line

  • Status code: The HTTP status code used to identify the specific error, such as 404 or 500. For details, see the Status code list below.
  • Status text: A brief description of the HTTP status code, such as Not Found.

• Response body: Contains the errors field, which provides detailed contextual information, such as parameter validation failures or business logic errors.

Example:

HTTP/1.1 404 Not Found
{
    "errors": "The product does not exist."
}

Status code list​

The following table lists the HTTP status codes used by the SHOPLINE API: