Saltar al contenido principal
GET
List stores

🏬 Buscar Tiendas

Este endpoint permite listar todas las tiendas asociadas a su cuenta. Las tiendas se devuelven en el orden de position (ascendente). Es ideal para:
  • Mostrar tiendas en paneles administrativos
  • Integrar datos con otros sistemas
  • Automatizar consultas de tiendas

🔐 Autenticación

Esta ruta exige autenticación vía API Key, enviada en el header de la petición:

📋 Ejemplo de Petición

📊 Ejemplo de Respuesta (200)

La primera llamada (sin cursor) ya devuelve nextCursor y hasMore en la paginación, permitiendo iniciar la paginación por cursor sin llamadas adicionales.

📌 Parámetros

Parámetros de consulta

Caso no existan tiendas en la página consultada, stores se devuelve como array vacío.

🔄 Paginación por cursor

Para listas grandes (más de ~100 elementos), prefiera la paginación por cursor en lugar de page:
  1. Realice la primera llamada sin cursor.
  2. Si hasMore es true, la respuesta incluye el campo nextCursor.
  3. Envíe ese nextCursor en el parámetro cursor de la siguiente petición para obtener la página siguiente.
En el modo cursor, la paginación se devuelve solo con nextCursor, hasMore y limit:
  • cursor y page no pueden usarse juntos (400 INVALID_PAGINATION).
  • nextCursor: null con hasMore: false indican el final de la lista (la API responde 200 con array vacío).

⚠️ Posibles errores

  • 400 INVALID_PAGINATION_LIMIT → limit fuera del intervalo permitido (1 a 100)
  • 400 INVALID_PAGINATION_PAGE → page inválida
  • 400 INVALID_PAGINATION_CURSOR → cursor inválido o malformado
  • 400 INVALID_PAGINATION → page y cursor utilizados juntos
  • 401 API_KEY_NOT_PROVIDED → header Authorization no enviado
  • 401 INVALID_API_KEY → API Key inválida o no encontrada
  • 401 UNAUTHENTICATED → sesión/usuario no autenticado
  • 403 USER_DISABLED → cuenta de usuario desactivada o eliminada
  • 403 NO_ACTIVE_SUBSCRIPTION → cuenta sin plan activo
  • 429 RATE_LIMIT_EXCEEDED → límite de solicitudes por minuto del plan excedido
  • 500 INTERNAL_SERVER_ERROR → error interno
  • 503 SERVICE_UNAVAILABLE → servicio temporalmente no disponible

🔗 Enlaces Útiles

Actualización: 23/05/2024 a las 13:00

Autorizaciones

Authorization
string
header
predeterminado:YOUR_API_KEY_HERE
requerido

Parámetros de consulta

page
integer
predeterminado:1
Rango requerido: x >= 1
limit
integer
predeterminado:20
Rango requerido: 1 <= x <= 100
cursor
string

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

Respuesta

Owner stores list ordered by position.

code
string
requerido
Ejemplo:

"SUCCESS"

pagination
object
requerido
stores
object[]
requerido