Saltar al contenido principal
GET
List products by category

📌 Endpoint

GET /stores/{storeId}/categories/{categoryId}/products Devuelve los productos públicos (no deshabilitados) que pertenecen a una categoría de una tienda. Los productos se devuelven en el orden de position (ascendente).

🔐 Autenticación

  • Ruta pública para consulta.
  • La tienda debe existir y tener plan activo.

🧾 Parámetros de ruta


✅ Ejemplo de solicitud


🔎 Parámetros de consulta


🔄 Paginación por cursor

Para listas grandes (más de ~100 ítems), prefiere la paginación por cursor en lugar de page:
  1. Haz la primera llamada sin cursor.
  2. Si hasMore es true, la respuesta trae el campo nextCursor.
  3. Envía ese nextCursor en el parámetro cursor de la siguiente solicitud para buscar 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).
  • Cuando no hay productos en la categoría, el modo offset (sin cursor) devuelve 404 PRODUCTS_NOT_FOUND, mientras que el modo cursor devuelve 200 con products: [], nextCursor: null y hasMore: false.
  • nextCursor: null con hasMore: false indican el fin de la lista (la API responde 200 con array vacío).

📦 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 extra.

⚠️ Posibles errores

  • 400 INVALID_DATA → parámetro inválido
  • 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 UNAUTHENTICATED → no fue posible identificar al usuario de la suscripción
  • 403 NO_ACTIVE_SUBSCRIPTION → plan inactivo o expirado
  • 404 STORE_NOT_FOUND → tienda no encontrada
  • 404 PRODUCTS_NOT_FOUND → ningún producto encontrado para la categoría (devuelto solo en modo offset cuando total es 0; en 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 o base de datos no disponible

Parámetros de ruta

storeId
string
requerido
Required string length: 1 - 50
categoryId
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 products by category.

code
string
requerido
Ejemplo:

"PRODUCTS_BY_CATEGORY_FETCHED"

products
object[]
requerido
pagination
object
requerido