Skip to main content
GET
Consultar un canje por código

Authorizations

x-api-key
string
header
required

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

Path Parameters

code
string
required

Código del canje.

Example:

"A1B2C3"

Response

Detalle del canje. Sin envelope.

id
number
required

ID del canje.

Example:

45012

code
string | null
required

Código que presenta el cliente para retirar el premio. Es el que se usa en POST /external/purchase/redeem/{code}.

Example:

"A1B2C3"

status
enum<string>
required

Estado del canje. Los canjes creados por la API nacen en pending.

Available options:
pending,
canceled,
delivered
Example:

"pending"

type
enum<string>
required

Si el canje fue por un premio o por dinero.

Available options:
product,
money
points
number
required

Puntos debitados al cliente.

Example:

500

moneyAmount
number | null
required

Monto en pesos. Solo en canjes por dinero.

Example:

null

product
object | null
required

Premio canjeado. null en canjes por dinero.

client
object | null
required

Cliente que canjeó.

branch
object | null
required

Sucursal donde se registró el canje.

createdAt
string<date-time>
required
Example:

"2026-07-28T18:05:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-07-28T18:05:00.000Z"