Skip to main content
POST
Canjear un premio

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

Body

application/json
productOfferId
number
required

ID de la oferta del premio a canjear. Sale del array offers de GET /external/products, eligiendo la que corresponde al nivel del cliente.

Example:

4412

clientId
number
required

ID del cliente que canjea. Se obtiene de GET /external/clients/search.

Example:

84213

Response

Canje creado en estado pending. El envelope trae status: 200 aunque el código HTTP sea 201.

success
boolean
required
Example:

true

status
integer
required
Example:

201

message
string
required
Example:

"Request was successful"

data
object