Saltar al contenido principal
GET
List coupons

📌 Endpoint

GET /stores/{storeId}/coupons Lista los cupones de la tienda (no expirados). Los cupones se devuelven en el orden de position (ascendente).

🔐 Autenticación

  • Ruta privada.
  • Requiere header Authorization con su API key y plan activo.

🧾 Parámetros de ruta


✅ Ejemplo de solicitud


🔎 Parámetros de consulta


🔄 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 solicitud para obtener la página siguiente.
En 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 fin de la lista (solo en modo cursor la API responde 200 con array vacío []; en modo offset con page, cuando el total es 0, la API devuelve 404 COUPONS_NOT_FOUND).

Snippet estándar (cURL)

Use el ejemplo cURL de la sección Ejemplo de solicitud anterior como snippet oficial.

📦 Respuesta exitosa (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.

⚠️ Posibles errores

  • 400 INVALID_DATA → parámetros inválidos
  • 400 INVALID_PAGINATION_LIMIT → limit fuera del rango 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 usados juntos
  • 401 API_KEY_NOT_PROVIDED → header Authorization no enviado
  • 401 INVALID_API_KEY → API key inválida
  • 401 UNAUTHENTICATED → usuario no autenticado
  • 403 USER_DISABLED → usuario deshabilitado
  • 403 NO_ACTIVE_SUBSCRIPTION → sin plan activo
  • 404 STORE_NOT_FOUND → tienda no encontrada
  • 404 COUPONS_NOT_FOUND → ningún cupón encontrado (devuelto en modo offset cuando el total es 0; solo el modo cursor devuelve 200 con [])
  • 429 RATE_LIMIT_EXCEEDED → límite de solicitudes por minuto excedido
  • 500 INTERNAL_SERVER_ERROR → error interno
  • 503 SERVICE_UNAVAILABLE → servicio no disponible

Autorizaciones

Authorization
string
header
predeterminado:YOUR_API_KEY_HERE
requerido

Parámetros de ruta

storeId
string
requerido
Required string length: 1 - 50

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

List coupons.

code
string
requerido
Ejemplo:

"COUPONS_FETCHED"

coupons
object[]
requerido
pagination
object
requerido