Buscar Lojas

🏬 Buscar Lojas

Este endpoint permite listar todas as lojas associadas à sua conta. As lojas sao retornadas na ordem de position (ascendente). Ele é ideal para:

Exibir lojas em painéis administrativos
Integrar dados com outros sistemas
Automatizar consultas de lojas

🔐 Autenticação

Esta rota exige autenticação via API Key, enviada no header da requisição:

Authorization: SUA_API_KEY_AQUI

📋 Exemplo de Requisição

curl --location "https://api.cabrapi.com.br/stores?page=1&limit=20" --header "Authorization: SUA_API_KEY_AQUI"

📊 Exemplo de Resposta

{
  "status": true,
  "code": "SUCCESS",
  "stores": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "teste",
      "position": 1,
      "description": "Loja de teste",
      "image": "https://example.com/image.png",
      "domain": "dominio.exemplo.com",
      "template": "PERSONALIZADO",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "createdAt": "2000-02-23T15:17:23.064Z",
      "updatedAt": "2000-02-23T15:17:50.527Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "nextCursor": null,
    "hasMore": false
  }
}

A primeira chamada (sem cursor) já retorna nextCursor e hasMore na paginação, permitindo iniciar a paginação por cursor sem chamadas extras.

📌 Parâmetros

Query params

Parâmetro	Tipo	Obrigatório	Descrição
`page`	number	Não	Página atual (padrão: `1`)
`limit`	number	Não	Itens por página (padrão: `20`, máximo: `100`)
`cursor`	string	Não	Cursor opaco para paginação por cursor. Use o `nextCursor` da resposta anterior. Não pode ser usado junto com `page`

Caso não existam lojas na página consultada, stores é retornado como array vazio.

🔄 Paginação por cursor

Para listas grandes (mais de ~100 itens), prefira paginação por cursor no lugar de page:

Faça a primeira chamada sem cursor.
Se hasMore for true, a resposta traz o campo nextCursor.
Envie esse nextCursor no parâmetro cursor da próxima requisição para buscar a página seguinte.

curl --location "https://api.cabrapi.com.br/stores?cursor=v1:SEU_CURSOR_AQUI&limit=20" --header "Authorization: SUA_API_KEY_AQUI"

No modo cursor, a paginação é retornada apenas com nextCursor, hasMore e limit:

{
  "status": true,
  "code": "SUCCESS",
  "stores": [ /* ... */ ],
  "pagination": {
    "nextCursor": "v1:e2xFn...",
    "hasMore": true,
    "limit": 20
  }
}

cursor e page não podem ser usados juntos (400 INVALID_PAGINATION).
nextCursor: null com hasMore: false indicam o fim da lista (a API responde 200 com array vazio).

⚠️ Possíveis erros

400 INVALID_PAGINATION_LIMIT → limit fora do intervalo permitido (1 a 100)
400 INVALID_PAGINATION_PAGE → page inválida
400 INVALID_PAGINATION_CURSOR → cursor inválido ou malformado
400 INVALID_PAGINATION → page e cursor utilizados juntos
500 INTERNAL_SERVER_ERROR → erro interno

🔗 Links Úteis

Update: 23/05/2024 as 13:00

Introdução

Lojas

Webhooks

Categorias

Produtos

Cupons

Pagamentos

Afiliados

Pagina da loja

🏬 Buscar Lojas

🔐 Autenticação

📋 Exemplo de Requisição

📊 Exemplo de Resposta

📌 Parâmetros

Query params

🔄 Paginação por cursor

⚠️ Possíveis erros

🔗 Links Úteis

​🏬 Buscar Lojas

​🔐 Autenticação

​📋 Exemplo de Requisição

​📊 Exemplo de Resposta

​📌 Parâmetros

​Query params

​🔄 Paginação por cursor

​⚠️ Possíveis erros

​🔗 Links Úteis

🏬 Buscar Lojas

🔐 Autenticação

📋 Exemplo de Requisição

📊 Exemplo de Resposta

📌 Parâmetros

Query params

🔄 Paginação por cursor

⚠️ Possíveis erros

🔗 Links Úteis