Obtener un cliente

Busca un cliente por su código y devuelve sus datos y su saldo de puntos.

GET/v1/clients/{client_code}API key del comercio

Busca un cliente por su código. El client_code es el número que tiene cada persona registrada en Loybox: es el que el cliente da en la caja y el que se usa para registrar un consumo.

Parámetros

client_codestringpathrequerido

El código del cliente.

Respuesta

Un objeto Cliente.

curl https://loybox-public-api-752998171300.southamerica-west1.run.app/v1/clients/12345 \
  -H "Authorization: Bearer $LOYBOX_API_KEY"
// 200 OK
{
  "code": 12345,
  "username": "Ana Pérez",
  "email": "ana@example.com",
  "points": 340
}

El campo points es el saldo disponible: puntos ganados vigentes menos puntos canjeados. Los puntos vencidos no cuentan. Ver Saldo.

Errores

CódigoCuándo
404El cliente no existe.
422El código no tiene un formato válido.