Skip to main content
GET
/
coupons
/
{couponId}
/
usages
Listar Usos de Cupom
curl --request GET \
  --url https://api.example.com/coupons/{couponId}/usages \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "couponUsageId": "019525fe-6d58-7ed8-d0fc-8a0b2c4e6f8c",
      "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "ext_ref_abc123",
      "amount": 500,
      "status": "APPLIED",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T00:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "totalItems": 1, "totalPages": 1 }
}
Requer permissao coupon:read.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
couponId
string
required
UUID do cupom.

​
Parametros de Query

​
page
integer
Numero da pagina.
​
limit
integer
Resultados por pagina.

​
Resposta

​
data
array
Lista de usos de cupom.
​
meta
object
Metadados de paginacao.
{
  "data": [
    {
      "couponUsageId": "019525fe-6d58-7ed8-d0fc-8a0b2c4e6f8c",
      "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "ext_ref_abc123",
      "amount": 500,
      "status": "APPLIED",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T00:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "totalItems": 1, "totalPages": 1 }
}

​
Exemplos de Codigo

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

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
500internal_server_errorOcorreu um erro inesperado