Lojas
Buscar Lojas
Aprenda a listar todas as lojas cadastradas na Cabra API usando o endpoint GET /stores.
GET
List stores
🏬 Buscar Lojas
Este endpoint permite listar todas as lojas associadas à sua conta. As lojas são retornadas na ordem deposition (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:📋 Exemplo de Requisição
📊 Exemplo de Resposta (200)
A primeira chamada (semcursor) já retornanextCursorehasMorena paginação, permitindo iniciar a paginação por cursor sem chamadas extras.
📌 Parâmetros
Query params
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 depage:
- Faça a primeira chamada sem
cursor. - Se
hasMorefortrue, a resposta traz o camponextCursor. - Envie esse
nextCursorno parâmetrocursorda próxima requisição para buscar a página seguinte.
nextCursor, hasMore e limit:
cursorepagenão podem ser usados juntos (400 INVALID_PAGINATION).nextCursor: nullcomhasMore: falseindicam o fim da lista (a API responde200com array vazio).
⚠️ Possíveis erros
400 INVALID_PAGINATION_LIMIT→limitfora do intervalo permitido (1a100)400 INVALID_PAGINATION_PAGE→pageinválida400 INVALID_PAGINATION_CURSOR→cursorinválido ou malformado400 INVALID_PAGINATION→pageecursorutilizados juntos401 API_KEY_NOT_PROVIDED→ headerAuthorizationnão enviado401 INVALID_API_KEY→ API Key inválida ou não encontrada401 UNAUTHENTICATED→ sessão/usuário não autenticado403 USER_DISABLED→ conta do usuário desativada ou excluída403 NO_ACTIVE_SUBSCRIPTION→ conta sem plano ativo429 RATE_LIMIT_EXCEEDED→ limite de requisições por minuto do plano excedido500 INTERNAL_SERVER_ERROR→ erro interno503 SERVICE_UNAVAILABLE→ serviço temporariamente indisponível