Pular para o conteúdo principal
GET
List stores

🏬 Buscar Lojas

Este endpoint permite listar todas as lojas associadas à sua conta. As lojas são 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:

📋 Exemplo de Requisição

📊 Exemplo de Resposta (200)

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

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:
  1. Faça a primeira chamada sem cursor.
  2. Se hasMore for true, a resposta traz o campo nextCursor.
  3. Envie esse nextCursor no parâmetro cursor da próxima requisição para buscar a página seguinte.
No modo cursor, a paginação é retornada apenas com nextCursor, hasMore e limit:
  • 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
  • 401 API_KEY_NOT_PROVIDED → header Authorization não enviado
  • 401 INVALID_API_KEY → API Key inválida ou não encontrada
  • 401 UNAUTHENTICATED → sessão/usuário não autenticado
  • 403 USER_DISABLED → conta do usuário desativada ou excluída
  • 403 NO_ACTIVE_SUBSCRIPTION → conta sem plano ativo
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto do plano excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno
  • 503 SERVICE_UNAVAILABLE → serviço temporariamente indisponível
Update: 23/05/2024 as 13:00

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de consulta

page
integer
padrão:1
Intervalo obrigatório: x >= 1
limit
integer
padrão:20
Intervalo obrigatório: 1 <= x <= 100
cursor
string

Opaque cursor from previous page (do not combine with page).

Resposta

Owner stores list ordered by position.

code
string
obrigatório
Exemplo:

"SUCCESS"

pagination
object
obrigatório
stores
object[]
obrigatório