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

# Introduction

> A brief introduction to the Consignease API.

Welcome to the Consignease API documentation. This guide will help you understand how to interact with the Consignease API to create,
retrieve, update, and delete Consignease resources through HTTP requests.

<section id="client-library" className="h-[900px]" />

## Base URL

All URLs referenced in the documentation have the following base:

```
https://api.consignease.app
```

<section id="authentication" className="h-[900px]">
  ## Authentication

  The Consignease API uses bearer authentication. When making requests, you must include your API token in the `Authorization`
  header in the format `Bearer <token>`. For more details, please refer to the [Authentication](./authentication) page.
</section>

<section id="rate-limits" className="h-[900px]">
  ## Rate Limiting

  Please note that the Consignease API has rate limits to prevent abuse and ensure service stability. If you exceed these limits,
  your requests will be throttled and you will receive a `429 Too Many Requests` response.
</section>

## Errorss

When an error occurs, the Consignease API responds with a conventional HTTP response code and a JSON object containing more
details about the error. For more information, please refer to the [Errors](./errors) page.

***

We hope this guide helps you get started with the Consignease API. If you have any questions, please don't hesitate to reach
out to our support team.

## Status Errorrr

<section id="status-error" className="h-[900px]">
  <h2 id="status-errorr">Status error</h2>

  Consignease uses conventional HTTP response codes to indicate the success or failure of an API request.
  In general: Codes in the 2xx range indicate success.
  Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter
  was omitted, a charge failed, etc.).
  Codes in the 5xx range indicate an error with Consignease's servers.

  Some 4xx errors that could be handled programmatically include
  an error code that briefly explains the error reported.
</section>

### Parameters

<ResponseField name="type" type="string">
  The type of error returned.

  One of <code>invalid\_request\_error</code>, <code>not\_found\_error</code>, <code>creation\_error</code>,
  <code>update\_error</code>, <code>deletion\_error</code>, <code>forbidden\_error</code>, or <code>authentication\_error</code>.
</ResponseField>

<ResponseField name="message" type="string">
  A human-readable message providing more details about the error.
</ResponseField>

<ResponseField name="params" type="array">
  If the error is parameter-specific, this will contain a list of the parameters that were invalid.
</ResponseField>

## HTTP Status Code Summary

Bellow is a summary of the HTTP status codes that Consignease API uses.

| HTTP Code          | Status            | Description                                                                                      |
| ------------------ | ----------------- | ------------------------------------------------------------------------------------------------ |
| 200                | OK                | Everything worked as expected.                                                                   |
| 400                | Bad Request       | The request was unacceptable, often due to missing a required parameter.                         |
| 401                | Unauthorized      | No valid API key provided.                                                                       |
| 402                | Request Failed    | The parameters were valid but the request failed.                                                |
| 403                | Forbidden         | The API key doesn't have permissions to perform the request.                                     |
| 404                | Not Found         | The requested resource doesn't exist.                                                            |
| 409                | Conflict          | The request conflicts with another request (perhaps due to using the same idempotent key).       |
| 429                | Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 | Server Errors     | Something went wrong on Consignease's end. (These are rare.)                                     |

<ResponseExample>
  ```json Response Example theme={null}
  {
    "error": {
      "type": "invalid_request_error",
      "params": [
        {
          "param": "name",
          "message": "This field is required"
        }
      ],
      "message": "Parameter error"
    }
  }
  ```
</ResponseExample>