Errors are a fundamental component of Wix's APIs, providing critical information and guidance when something goes wrong. Most of Wix's errors follow a standardized format, as described below.
| Property | Description |
|---|---|
| Status code | See the HTTP status code table below. |
message | Textual description that provides a brief explanation of the error. |
details | Additional contextual information about the error, including either applicationError or validationError. See the tables below. |
Every API call will return a status code. If something went wrong, you'll receive an error code that defines the type of error that occurred.
Status code types include:
| HTTP Status Code | Description |
|---|---|
| 200 - OK | Success. No error. |
| 400 - Bad Request | One or more request parameters is wrong or missing, or you didn't pass validation. |
| 401 - Unauthorized | The system wasn't able to authenticate you (missing or incorrect Authorization header, expired token, etc.). Occasionally returned when you don’t have permissions to call this API. |
| 403 - Permission denied | The system authenticated you, but you don’t have permissions to call this API. |
| 404 - Not found | Resource not found / doesn't exist. |
| 409 - Conflict | The resource you are attempting to create already exists or has a different revision than the one you're attempting to update, or another conflict with the server state. |
| 428 - Precondition required | Preconditions must be met for the request to be successful (for example, a required field wasn't passed, or the passed gift card is out of funds). |
| 429 - Resource exhausted | Resource usage was exhausted (for example, a previously used one-time-token, or too many requests). |
| 500 - Internal server error | An error occurred on Wix's server. Try again later. |
| 501 - Not implemented | The endpoint hasn't been implemented yet. |
| 503 - Service unavailable | The service that you’re trying to access is temporarily unavailable. Try again later. |
| 504 - Gateway timeout | The underlying service didn't respond in a timely manner. Try again later. If you're trying to query for data, you may try a smaller page size or a simpler filter. |
An application error occurs when the service business-logic decides to reject the request. This includes codes like UNAUTHENTICATED, PERMISSION_DENIED, NOT_FOUND, ALREADY_EXISTS, ABORTED and RESOURCE_EXHAUSTED.
| Property | Description |
|---|---|
code | Identifier that categorizes and signifies the specific error. |
description | Detailed explanation of why the error occurred. |
data | Additional contextual information related to the error. |
A validation error occurs when input data fails to meet predefined criteria or constraints set by the system. This type of error serves to enforce rules such as correct data formats, required fields, or value ranges. This includes rules like OUT_OF_RANGE and INVALID_ARGUMENT. Validation errors are 4xx types. Multiple violations may be returned in one response.
| Property | Description |
|---|---|
fieldViolations | Array of validation issues found in individual fields. |
fieldViolations.field | Field name. |
fieldViolations.description | Detailed explanation of why the error occurred for the specified field. |
fieldViolations.violatedRule | Specific rule or constraint that was violated by the input in the identified field. |
fieldViolations.ruleName | Name of specific rule or constraint that was violated. For example, "VALIDATION_ERROR". |
fieldViolations.data | Additional contextual information related to the field violation. |
A system error occurs when there's an exception in the system, server is down, or some dependent service or database is down.
These errors are sent empty by design. System errors are 5xx types.