Skip to main content
POST
Crear una oferta de puntos (QR o email)

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
amount
number
required

Monto de la compra en pesos que se va a convertir en puntos cuando el cliente reclame la oferta.

Example:

50

type
enum<string>
required

Cómo se le entrega la oferta al cliente. Este endpoint soporta qr-fixed, qr-variable y email; el resto de los valores del enum devuelven data: null.

Available options:
qr-fixed,
qr-variable,
email,
whatsapp,
link,
gift-card,
inactivity-reminder
Example:

"qr-variable"

description
string

Descripción de la oferta. Se usa como nombre del QR.

Example:

"Compra de $50"

email
string

Email al que se envía la oferta. Obligatorio cuando type es email.

Example:

"juanma@mailinator.com"

Response

Oferta creada. 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 | null