Referencia · Catálogo

Lista paginada de productos

GET/products

Devuelve productos EN_VENTA y AGOTADO, del más nuevo al más viejo. Los borradores y archivados nunca aparecen. Los filtros por atributo y por precio no están disponibles todavía.

Cada producto trae solo su primera imagen; GET /products/{id} las trae todas.

Bajo una ráfaga, esta lectura y la del detalle pueden servir la última respuesta conocida, de hasta 10 minutos, o responder 429 si no hay ninguna. Nunca responden un catálogo vacío por eso. Con pk_ aplican los límites por visitante de la tienda; con sk_, solo el total de la tienda.

Parámetros de consulta

qtexto

Búsqueda sin distinguir acentos. Cada palabra tiene que aparecer en el nombre, la descripción, la categoría o las etiquetas.

Máximo 100 caracteres.

categoryIdtexto

Filtra por categoría; una categoría raíz incluye sus subcategorías visibles. Una categoría oculta, inexistente o de otra tienda devuelve una página vacía.

De 1 a 64 caracteres.

pageentero

De 1 a 100000, por defecto 1.

limitentero

De 1 a 100, por defecto 24.

Respuestas

EstadoCódigoQué significa
200—

Página de productos.

400
  • INVALID_QUERY
  • INVALID_BODY
  • IDEMPOTENCY_KEY_REQUIRED
  • SHIPPING_METHOD_INACTIVE
  • SHIPPING_METHOD_REQUIRED
  • PAYMENT_METHOD_UNAVAILABLE
  • STRIPE_NOT_AVAILABLE
  • STRIPE_CURRENCY_NOT_SUPPORTED
  • STRIPE_AMOUNT_NOT_ALLOWED
  • STRIPE_REJECTED
  • RETURN_URL_INVALID
  • PAGOPAR_NOT_ACTIVE
  • PAGOPAR_REJECTED
  • FILE_INVALID

Solicitud rechazada. Con code: INVALID_QUERY (un parámetro de una lectura está fuera de rango o mal formado), INVALID_BODY (el cuerpo no es JSON o no respeta los tipos y formatos del contrato), IDEMPOTENCY_KEY_REQUIRED (ausente o mal formada), SHIPPING_METHOD_INACTIVE, SHIPPING_METHOD_REQUIRED, PAYMENT_METHOD_UNAVAILABLE (un método manual inactivo, un método estándar en una tienda con otro medio configurado, Stripe incluido, o viaStripe/viaPagopar con algo distinto de TARJETA sin método manual), STRIPE_NOT_AVAILABLE (la tienda no tiene el pago con tarjeta disponible), STRIPE_CURRENCY_NOT_SUPPORTED (la tienda no vende en guaraníes), STRIPE_AMOUNT_NOT_ALLOWED (el total supera el máximo por venta), STRIPE_REJECTED (Stripe no aceptó iniciar el pago), RETURN_URL_INVALID (returnUrl ausente o que no es una URL https de un origen autorizado), PAGOPAR_NOT_ACTIVE (Pagopar está retirado: es lo que responde todo intento de usarlo), PAGOPAR_REJECTED (sin uso hoy), FILE_INVALID (sin archivo, tipo no permitido o contenido que no coincide). Muchos rechazos del checkout (datos del comprador, ciudad, cupón, líneas) solo traen message.

401
  • API_KEY_INVALID

Clave ausente, inválida o revocada: API_KEY_INVALID.

403
  • STOREFRONT_API_PLAN_REQUIRED
  • ORIGIN_NOT_ALLOWED
  • SECRET_KEY_IN_BROWSER
  • STORE_INACTIVE
  • ALTCHA_REQUIRED
  • ALTCHA_INVALID
  • ALTCHA_EXPIRED
  • ALTCHA_REPLAY

STOREFRONT_API_PLAN_REQUIRED (la tienda no está en el plan PRO; no aplica a GET /orders/{token} ni a GET /orders/by-payment-hash/{hash}), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, STORE_INACTIVE (tienda pausada o archivada; solo catálogo, cotización y checkout), o en el checkout ALTCHA_REQUIRED, ALTCHA_INVALID, ALTCHA_EXPIRED, ALTCHA_REPLAY.

429
  • RATE_LIMITED

RATE_LIMITED. Respetar Retry-After. Sin datos para servir, también en una lectura de catálogo degradada.

500—

Error del servidor. En el checkout se puede reintentar con la misma Idempotency-Key.

503
  • SERVICE_UNAVAILABLE

SERVICE_UNAVAILABLE: no se pudo verificar la clave o el plan de la tienda, o Stripe no respondió al iniciar un pago. No dice nada de la clave ni del plan: reintentar después de Retry-After.