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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Introdução

> Gerencie todos os recursos de uma loja através da nossa API REST.

## Endpoints

Cada loja possui um alias exclusivo. O endpoint base é:\
`https://api.dooki.com.br/v2/{merchantAlias}`

## Headers

Inclua o header `Content-Type: application/json` em todas as requisições.

## Paginação

Por padrão, a API retorna 10 resultados por página. Use o parâmetro `limit` para ajustar esse valor.

Os detalhes da paginação são retornados no nó `meta` da resposta:

```json theme={"system"}
{
  "meta": {
    "pagination": {
        "total": 1000,
        "count": 10,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 100,
        "links": {
            "next": "https://api.dooki.com.br/v2/{merchantAlias}/foo?page=2"
        }
    }
  }
}
```

## Includes

Nem todas as requisições retornam o payload completo de um recurso. Use o parâmetro `include` para adicionar objetos relacionados à resposta.

Exemplo de uso:\
`https://api.dooki.com.br/v2/{alias}/catalog/products?include=skus`

Para múltiplos includes:\
`https://api.dooki.com.br/v2/{alias}/catalog/products?include=skus,images`

Encadeamento de includes:\
`https://api.dooki.com.br/v2/{alias}/catalog/products?include=skus.prices.installments`

## Cache

Consultas GET possuem cache de 30 minutos por padrão. Para ignorar o cache, use o parâmetro `skipCache=true`:\
`https://api.dooki.com.br/v2/{merchantAlias}/catalog/products?skipCache=true`