Skip to main content
GET
/
coupons
/
{couponId}
Buscar Cupom
curl --request GET \
  --url https://api.example.com/coupons/{couponId} \
  --header 'Authorization: <authorization>'
{
  "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
  "externalRef": null,
  "code": "WELCOME10",
  "name": "Welcome Discount",
  "type": "PERCENTAGE",
  "amount": 10,
  "currency": "BRL",
  "duration": "ONCE",
  "durationInMonths": null,
  "maxRedemptions": 100,
  "redeemBy": null,
  "timesRedeemed": 25,
  "amountRedeemed": 12500,
  "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",
  "deletedBy": null,
  "deletedAt": null
}
Requer permissao coupon:read.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
couponId
string
required
UUID do cupom.

​
Resposta

​
couponId
string
UUID do cupom.
​
externalRef
string
Referencia externa.
​
code
string
Codigo do cupom.
​
name
string
Nome do cupom.
​
type
string
Tipo de desconto.
​
amount
integer
Discount amount.
​
currency
string
Codigo da moeda.
​
duration
string
Duration type.
​
durationInMonths
integer
Duration in months.
​
maxRedemptions
integer
Maximum redemptions.
​
redeemBy
string
Data de expiracao.
​
timesRedeemed
integer
Times redeemed.
​
amountRedeemed
integer
Total amount redeemed.
​
status
string
Status do cupom.
​
createdBy
string
Identificador do criador.
​
createdAt
string
Timestamp de criacao.
​
updatedBy
string
Identificador do ultimo atualizador.
​
updatedAt
string
Timestamp da ultima atualizacao.
​
deletedBy
string
Deleter identifier.
​
deletedAt
string
Deletion timestamp.
{
  "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
  "externalRef": null,
  "code": "WELCOME10",
  "name": "Welcome Discount",
  "type": "PERCENTAGE",
  "amount": 10,
  "currency": "BRL",
  "duration": "ONCE",
  "durationInMonths": null,
  "maxRedemptions": 100,
  "redeemBy": null,
  "timesRedeemed": 25,
  "amountRedeemed": 12500,
  "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",
  "deletedBy": null,
  "deletedAt": null
}

​
Exemplos de Codigo

curl https://api.awsales.io/admin/coupons/019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
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