Skip to main content
GET
Listar premios

Authorizations

x-api-key
string
header
required

API key del comercio. Se genera desde el panel de Tienda de Puntos, en Configuración → Integraciones.

Headers

x-branch-id
integer

ID de la sucursal en la que se registra la operación. Si se omite, la operación queda asociada al comercio sin sucursal.

Example:

1972

Query Parameters

order
enum<string>

Campo por el que ordenar.

Available options:
name,
stock,
createdAt,
points
levelId
number

Devuelve solo los premios que tengan una oferta para este nivel. Los IDs salen de GET /external/levels.

Example:

3

isEnabled
boolean

Filtra por premios habilitados. Si vas a mostrar el catálogo a un cliente, usá true: los deshabilitados no son canjeables desde la API.

Example:

true

page
integer
default:1
Required range: x >= 1
Example:

1

limit
integer
default:10

Cantidad de resultados por página. Máximo 200.

Required range: 1 <= x <= 200
Example:

10

query
string

Búsqueda parcial por nombre.

Example:

"café"

direction
enum<string>
default:desc

Sentido del orden. Solo aplica si se envía order.

Available options:
asc,
desc

Response

Página de premios. Sin envelope.

data
object[]
meta
object