Skip to main content
GET
/
coupons
/
{code}
/
availability
Verificar Disponibilidade do Cupom
curl --request GET \
  --url https://api.example.com/coupons/{code}/availability \
  --header 'Authorization: <authorization>'
{
  "coupon": {
    "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
    "externalRef": "cpn_1Oy2pL2eZvKYlo2C0vIqMZ8y",
    "code": "WELCOME10",
    "name": "Welcome Discount",
    "type": "PERCENTAGE",
    "amount": 10,
    "currency": "BRL",
    "duration": "ONCE",
    "durationInMonths": null,
    "maxRedemptions": 100,
    "redeemBy": null,
    "timesRedeemed": 25,
    "amountRedeemed": 5000,
    "status": "ACTIVE",
    "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  },
  "meta": {
    "available": true
  }
}
Verifica a disponibilidade do cupom. 
curl https://api.awsales.io/studio/coupons/WELCOME10/availability \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Sempre verifique a disponibilidade do cupom antes de apresentar informacoes de desconto ao usuario. Um cupom pode ter sido esgotado ou expirado desde a ultima vez que o usuario o viu.
Requer permissao coupon:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
code
string
required
O codigo do cupom a verificar.

​
Resposta

​
coupon
object
O objeto cupom.
​
meta
object
Metadados de disponibilidade.
{
  "coupon": {
    "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
    "externalRef": "cpn_1Oy2pL2eZvKYlo2C0vIqMZ8y",
    "code": "WELCOME10",
    "name": "Welcome Discount",
    "type": "PERCENTAGE",
    "amount": 10,
    "currency": "BRL",
    "duration": "ONCE",
    "durationInMonths": null,
    "maxRedemptions": 100,
    "redeemBy": null,
    "timesRedeemed": 25,
    "amountRedeemed": 5000,
    "status": "ACTIVE",
    "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  },
  "meta": {
    "available": true
  }
}

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404coupon.not_foundCupom nao encontrado
500internal_server_errorOcorreu um erro inesperado