Crear consumo por código

Registra una compra usando el código del cliente, para que sume puntos.

POST/v1/consumptions/client-codeAPI key del comercio

Registra un nuevo consumo usando el código del cliente. Es la llamada que suma los puntos de una compra.

El cliente tiene que existir: si el código no corresponde a ningún cliente, la llamada devuelve 404 y no se registra nada. Si preferís que el consumo se registre igual, usá crear consumo por email.

Cuerpo

client_codeintegerrequerido

El código del cliente que hizo la compra.

amountintegerrequerido

Monto de la compra, en unidades enteras de la moneda del comercio.

counter_idinteger

Id de la caja donde se hizo la compra.

id_sucinteger

Id de la sucursal donde se hizo la compra.

Ejemplo

curl -X POST https://loybox-public-api-752998171300.southamerica-west1.run.app/v1/consumptions/client-code \
  -H "Authorization: Bearer $LOYBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "client_code": 12345,
    "amount": 1750,
    "counter_id": 2,
    "id_suc": 1
  }'
// 201 Created
{
  "message": "Consumption created successfully"
}

La respuesta no dice cuántos puntos sumó. Para verlo, consultá al cliente con GET /v1/clients/{client_code}.

Errores

CódigoCuándo
400No se pudo crear el consumo.
403El cliente existe pero no es elegible para tener consumos.
404El cliente no existe.
422Falta un campo del cuerpo o tiene el tipo equivocado. Ver Errores de validación.

En esta página