docs
  1. SCAYLE Resource Center
  2. Admin API
  3. Getting Started
  4. Errors

Errors

The Admin API uses HTTP status codes to indicate the success or failure of an API request. In general:

  • 2xx range indicates success
  • 3xx range indicates a redirect
  • 4xx range indicates a failure caused by the provided information
  • 5xx range indicates a problem with our servers

If an error occurs, the API responds with an error response containing a list of errors. In most cases, the list will contain a single error. However, some endpoints might return multiple errors.

The status codes, error responses, and error entities are provided in the tables below.

HTTP Status Codes

200s status codes

HTTP Status CodeDescription
200 OKRequest has been fulfilled.
201 CreatedRequest has been fulfilled and new resource created.
204 No ContentThere is no content for a successful request.
206 Partial ContentRequest has been fulfilled for the partial content requested.

400s status codes

HTTP Status CodeDescription
400 Bad RequestMissing or invalid parameter.
401 UnauthorizedNo or invalid access token.
403 ForbiddenYou have not been unauthorized to access the resource.
404 Not FoundRequested resource doesn't exist.
408 Request TimeoutThe client failed to complete the request within a certain timeframe.
409 ConflictRequested resource could not be processed because of a conflict.
412 Precondition FailedPreconditions were not met.
413 Payload Too LargeThe request entity is larger than limits defined by server.
424 Failed DependencyRequest failed due to a failure of dependency.

500s status codes

HTTP status codeDescription
500 Internal Server ErrorUnexpected error on Storefront API server.
502 Bad GatewayServer got an invalid response.
503 Service UnavailableService unavailable due to internal errors.
504 Gateway TimeoutThe server took too long to respond.

Complete list of HTTP status codes.

Error Response

ParameterDetails
errorKey

String

A key that describes the occurred error.

message

String

Description of the error.

context

Array

Additional context to interpret the error message.

Error Entity

ParameterDetails
field

String

Describe field where the error occurred.

description

String

Some human-readable description of the error.

Error Handling

When using a SDK to consume the Admin API endpoints, it is good practice to catch possible errors.

try {
    $productCollection = $adminApi->products->all();
} catch (ApiErrorException $apiException) {
    // Get the first error
    echo $apiException->getFirstError()->getMessage();

    // Get all errors
    foreach ($apiException->getErrors() as $error) {
        echo $error->getMessage();
    }
} catch (Exception $exception) {
    // e.g. Connection problems
}