Obtener un beneficio
Los datos de un beneficio del catálogo, por su benefit_id.
GET/v1/benefits/{benefit_id}API key del comercio
Trae información sobre un beneficio del catálogo usando su id.
Este endpoint no canjea nada
El benefit_id identifica un beneficio del catálogo, no el de un cliente
concreto. Para consultar el beneficio que un cliente trae para usar, el
identificador es el client_benefit_code y el endpoint es
consultar un código.
Parámetros
benefit_idstringpathrequeridoEl id del beneficio.
Respuesta
Un objeto Beneficio.
curl https://loybox-public-api-752998171300.southamerica-west1.run.app/v1/benefits/b_9f2a \
-H "Authorization: Bearer $LOYBOX_API_KEY"// 200 OK
{
"id": "b_9f2a",
"type": "percentage_discount",
"description": "20% de descuento en toda la tienda",
"cost": 250,
"expiration": "2026-12-31T23:59:59Z",
"benefit_type": "normal",
"color": "#f1a10d",
"buy_limit": 0,
"prize": {
"type": "percentage_discount",
"title": "20% off",
"description": "Válido en toda la tienda",
"value": 20,
"product": null,
"expiration": "2026-12-31T23:59:59Z",
"image": null
},
"tiendanube_coupon": null
}Errores
| Código | Cuándo |
|---|---|
401 | La API key es inválida: no tiene un comercio asociado. |
404 | El beneficio no existe. |
422 | El id no tiene un formato válido. |