Skip to main content
POST
Sumar puntos a un cliente por una compra

Authorizations

x-api-key
string
header
required

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

Body

application/json
client
object
required

Datos del cliente que hizo la compra.

amount
number

Monto de la compra en pesos. La conversión a puntos la define la regla de puntos configurada por el comercio. Se ignora si mandás pointItems. Es obligatorio salvo que vengan pointItems.

Example:

50

pointItems
number[]

IDs de los ítems de puntos ya cargados en el comercio. Si viene, los puntos se calculan a partir de los ítems y amount se ignora: el monto de la operación es la suma de los montos de los ítems. Repetí el mismo id para cargar más de una unidad (máximo 100 ids).

Example:
operator
object

Datos del operador o cajero que registró la venta.

branch_id
number

ID de la sucursal donde se hizo la compra. Se obtiene de GET /external/branch. Debe pertenecer al comercio de la API key.

Example:

1972

external_id
string

Identificador de la transacción en tu sistema (número de factura, id de ticket). Es la clave de idempotencia: si repetís un external_id que ya tiene una operación activa, la API responde 409 en vez de duplicar los puntos. También es el identificador con el que después se cancela la operación.

Example:

"FAC-A-0001-00012345"

reason
string

Observaciones de la suma de puntos.

Example:

"Suma por compra de 2 medialunas y un cafe latte"

applyBonus
object

Bonificaciones a aplicar sobre los puntos base. Si se omite, no se aplica ninguna.

giftCards
object[]

Gift cards de regalo para otro cliente.

ignoreCreateClient
boolean

Si llega en true y el cliente no existe, la operación falla en vez de darlo de alta automáticamente.

Example:

false

origin
enum<string>

Sistema desde el que se originó la operación. Se usa para trazabilidad en los reportes. Si integrás un sistema propio, usá external-integration.

Available options:
external-integration,
dragonfish,
fudo,
centum,
contabilium,
tiendanube,
woocommerce,
shopify,
desktop-app,
dux
Example:

"external-integration"

extra_data
string

Datos crudos de la operación en el sistema de origen, como JSON serializado. Hoy solo se persiste cuando origin es dragonfish (son los renglones de la factura, que el export de movimientos muestra en la columna "Artículos"). Para cualquier otro origen se ignora en silencio.

Example:

"[{\"ArticuloDetalle\":\"Remera negra\",\"Cantidad\":3,\"Talle\":\"M\"}]"

Response

Puntos acreditados.

success
boolean
required
Example:

true

status
integer
required
Example:

201

message
string
required
Example:

"Request was successful"

data
object