Auth & Identidade
Gestão de Acesso
Listar Cupons
curl --request GET \
--url https://api.example.com/coupons \
--header 'Authorization: <authorization>'{
"data": [
{
"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
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 10, "totalPages": 1 }
}
Coupons
Listar Cupons
Recuperar uma lista paginada de todos os cupons com opcoes de filtragem e ordenacao.
GET
/
coupons
Listar Cupons
curl --request GET \
--url https://api.example.com/coupons \
--header 'Authorization: <authorization>'{
"data": [
{
"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
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 10, "totalPages": 1 }
}
Requer permissao
coupon:read.Headers
Bearer token.
Parametros de Query
Numero da pagina.
Resultados por pagina.
Filter by duration.
Filtrar por status.
Filtrar por tipo.
Campo de ordenacao.
Direcao da ordenacao.
Resposta
Lista de cupons.
Show propriedades do cupom
Show propriedades do cupom
UUID do cupom.
Referencia externa.
Codigo do cupom.
Nome do cupom.
Tipo de desconto.
Discount amount.
Codigo da moeda.
Duration type.
Duration in months.
Maximum redemptions.
Data de expiracao.
Times redeemed.
Total amount redeemed.
Status do cupom.
Identificador do criador.
Timestamp de criacao.
Identificador do ultimo atualizador.
Timestamp da ultima atualizacao.
Deleter identifier.
Deletion timestamp.
{
"data": [
{
"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
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 10, "totalPages": 1 }
}
Exemplos de Codigo
curl https://api.awsales.io/admin/coupons?page=1&limit=20 \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.