> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yorlet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Errors

```json theme={"theme":"dracula"}
{
  "error": {
    "message": "The supplied customer was not found.",
    "param": "customer",
    "type": "invalid_request"
  },
  "status": 404
}
```

Yorlet uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the <code>2xx</code> range indicate success. Codes in the <code>4xx</code> range indicate an error that failed given the information provided. Codes in the <code>5xx</code> range indicate an error with Yorlet's servers.

#### Attributes

* <div class="method-list-item">
    <span class="method-list-item-label">
      <span class="method-list-item-name">error</span>
      <span class="method-list-item-type">object</span>
    </span>

    <div class="method-list-item-description">The error object.</div>

    <div class="method-list-children">
      <div class="method-list-item-child">
        <span class="method-list-item-label">
          <span class="method-list-item-name">
            <span class="oK">error</span>.message
          </span>

          <span class="method-list-item-type">string</span>
        </span>

        <div class="method-list-item-description">
          A human-readable message providing more details about the error.
        </div>
      </div>

      <div class="method-list-item-child">
        <span class="method-list-item-label">
          <span class="method-list-item-name">
            <span class="oK">error</span>.param
          </span>

          <span class="method-list-item-type">string</span>
        </span>

        <div class="method-list-item-description">
          If the error is parameter-specific, the parameter related to the
          error.
        </div>
      </div>

      <div class="method-list-item-child">
        <span class="method-list-item-label">
          <span class="method-list-item-name">
            <span class="oK">error</span>.type
          </span>

          <span class="method-list-item-type">string</span>
        </span>

        <div class="method-list-item-description">
          The type of error returned.
        </div>
      </div>
    </div>
  </div>
* <div class="method-list-item">
    <span class="method-list-item-label">
      <span class="method-list-item-name">status</span>
      <span class="method-list-item-type">integer</span>
    </span>

    <div class="method-list-item-description">The status code.</div>
  </div>

| Error code                         | Meaning                                                                  |
| ---------------------------------- | ------------------------------------------------------------------------ |
| <code>400</code> Bad Request       | The request was unacceptable, often due to missing a required parameter. |
| <code>401</code> Unauthorized      | No valid API key was provided.                                           |
| <code>403</code> Forbidden         | The API key doesn't have permissions to perform the request.             |
| <code>404</code> Not Found         | The requested resource doesn't exist.                                    |
| <code>429</code> Too Many Requests | Too many requests hit the API too quickly.                               |
| <code>5XX</code> Server Error      | We had a problem with our server. Try again later.                       |
