Consulte cupons elegíveis

Guias

Consulte cupons elegíveis

Use o endpoint de elegibilidade para descobrir cupons disponíveis para consumidor, carrinho e contexto comercial.

Use QUERY /v1/coupon/eligibility quando a aplicação precisa descobrir ofertas antes de conhecer um código específico. O método QUERY permite enviar um corpo estruturado sem alterar dados.

Monte o contexto

{
  "context": {
    "user": { "id": "user-001" },
    "location": { "country": "BR", "state": "SP" },
    "payment_method": "pix",
    "cart": [
      { "id": "product-001", "quantity": 2, "unitary_price": 49.90 }
    ],
    "shipping": { "amount": 12.50 },
    "public": true
  },
  "pagination": { "page": 1, "per_page": 20 }
}

Envie a consulta

curl --request QUERY 'https://api.cupom.center/v1/coupon/eligibility' \
  --header "Authorization: Bearer $CUPOM_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @context.json

Interprete o resultado

A resposta informa cupons compatíveis e dados necessários para apresentação. Trate paginação e ausência de resultados como situações normais. A elegibilidade não reserva budget nem confirma uso.

Para seleção automática por unidade, consulte na referência os endpoints de elegibilidade units/single e units/multiple.