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

# Introdução

> Leia os pedidos da sua conta Zouti a partir do seu ERP, CRM, planilha ou BI.

A API pública da Zouti dá acesso de leitura aos pedidos da sua conta: os pedidos em que a conta é
dona e os de coprodução. Use-a para levar vendas, pagamentos, estornos e chargebacks para o seu
ERP, CRM, planilha ou ferramenta de BI.

A API é REST, só leitura (`GET`), e responde em JSON. Toda requisição se autentica com uma chave de
API da conta.

## Endereço base

```text theme={null}
https://api.zouti.com.br/v1
```

Todo caminho desta documentação é relativo a esse endereço. Por exemplo, `GET /v1/orders` é
`https://api.zouti.com.br/v1/orders`.

## Convenções

<Warning>
  **Somente HTTPS.** Requisição em HTTP recebe `400` com corpo em texto puro, sem redirecionamento.
  Se uma chave já foi enviada por HTTP, ela trafegou sem criptografia: revogue-a e crie outra.
</Warning>

* **JSON.** As respostas da API vêm em JSON (`application/json`). As respostas geradas na borda
  (balanceador de carga e WAF) vêm sem corpo JSON e sem `Request-Id`: o `400` de uma requisição
  em HTTP, o `429` do limite de volume por IP, o `403` da proteção do WAF contra entradas
  maliciosas e um `5xx` do balanceador de carga.
* **Valores em centavos.** Todo valor monetário é um inteiro em centavos: `27730` é R\$ 277,30.
* **Datas em ISO 8601, UTC.** As datas das respostas vêm em UTC, como
  `2026-10-14T13:05:22.418Z`. Os filtros de data aceitam qualquer fuso, mas o fuso é obrigatório:
  `2026-10-01T00:00:00-03:00` vale; `2026-10-01` é recusado.
* **Formato fixo.** Campo sem valor vem `null`, nunca ausente. A exceção são as chaves dentro de
  `metadata`, que só aparecem quando existem no pedido.
* **`Request-Id`.** Toda resposta da API traz o header `Request-Id` (`req_...`). Guarde-o no seu
  log e informe-o ao suporte quando relatar um problema.

## Por onde começar

<CardGroup cols={2}>
  <Card title="Primeiros passos" icon="rocket" href="/quickstart">
    Crie uma chave e faça a primeira chamada em poucos minutos.
  </Card>

  <Card title="Autenticação" icon="key" href="/concepts/authentication">
    Como enviar a chave, guardá-la e trocá-la sem parar a integração.
  </Card>

  <Card title="Objeto pedido" icon="receipt" href="/api-reference/order-object">
    Todos os campos do pedido e os valores de cada status.
  </Card>

  <Card title="Sincronização de pedidos" icon="arrows-rotate" href="/concepts/sync">
    Mantenha uma cópia local dos pedidos com uma consulta periódica.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.