POST/api/v1/integrations/eligibility

🔐 Bearer (OAuth) o X-Api-KeyContrato en borrador

Indica si el colaborador identificado tiene hoy beneficios en tu comercio y cuáles son. Es elegible cuando:

• está activo en su empresa,
• su empresa está afiliada a tu comercio, y
• la empresa le otorga (a todo el equipo o a su tipo de colaborador) al menos un descuento vigente tuyo.

Privacidad

Una identificación que no existe y un colaborador sin beneficios responden igual: eligible: false, sin datos. La identificación viaja en el cuerpo de un POST para que nunca quede en URLs ni en logs de acceso.

Petición

Campo	Tipo	Requerido	Descripción
identificationTypeId	integer	Sí	Tipo de identificación. Ver Tipos de identificación.
identification	string (1–30)	Sí	Número de identificación, sin guiones ni espacios.
branchId	integer	No	Sucursal de tu comercio donde ocurre la compra.
purchaseAmount	number	No	Monto de la compra. Si lo envías, cada descuento trae estimatedDiscountAmount.

OAuth (Bearer)

curl -s -X POST "$COME_BASE_URL/api/v1/integrations/eligibility" \
  -H "Authorization: Bearer $COME_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identificationTypeId": 1,
    "identification": "00000000000",
    "branchId": 12,
    "purchaseAmount": 1500.00
  }'

API key

curl -s -X POST "$COME_BASE_URL/api/v1/integrations/eligibility" \
  -H "X-Api-Key: $COME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "identificationTypeId": 1, "identification": "00000000000", "purchaseAmount": 1500.00 }'

Respuesta 200

Elegible

{
  "title": "Eligibility",
  "messages": [{ "message": "Query successful" }],
  "value": {
    "eligible": true,
    "collaborator": { "displayName": "Ana P.", "companyName": "Empresa Demo S.R.L." },
    "discounts": [
      {
        "merchantDiscountId": 45,
        "name": "15% en todo el menú",
        "description": "Aplica de lunes a viernes.",
        "discountType": { "id": 1, "name": "Porcentaje", "code": "PCT" },
        "discountValue": 15.0,
        "scope": { "typeId": 1, "name": "Toda la tienda", "articleCategoryId": null, "articleId": null },
        "validFrom": "2026-09-01T00:00:00Z",
        "validTo": "2026-12-31T23:59:59Z",
        "estimatedDiscountAmount": 225.0
      }
    ]
  },
  "meta": null
}

No elegible

{
  "title": "Eligibility",
  "messages": [{ "message": "Query successful" }],
  "value": { "eligible": false, "collaborator": null, "discounts": [] },
  "meta": null
}

Campo de value	Descripción
eligible	true si tiene al menos un beneficio vigente en tu comercio.
collaborator.displayName	Primer nombre e inicial del apellido, para confirmar con el cliente.
collaborator.companyName	Empresa afiliada del colaborador.
discounts[]	Descuentos que puedes aplicar. Usa merchantDiscountId en Aplicar descuento.
discounts[].discountType.code	PCT (porcentaje) o monto fijo según el catálogo de COME.
discounts[].scope	Toda la tienda, una categoría (articleCategoryId) o un artículo (articleId).

Errores

HTTP	Cuándo
400	Falta identificationTypeId o identification, o tienen un formato inválido.
401 / 403	Problema con la credencial. Ver Autenticación.
429	Demasiadas consultas. Respeta Retry-After.