Skip to main content
GET
/
organizations
/
{organizationId}
/
vouchers
/
{voucherId}
/
usages
Listar Usos de Voucher
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/vouchers/{voucherId}/usages \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "voucherUsageId": "019525fe-7e6c-7fe9-e1ad-9b1c3d5f7a9d",
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "discountAmount": 2500,
      "externalRef": "di_stripe_abc",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1
  }
}
Retorna uma lista de usos de voucher.
curl "https://api.awsales.io/studio/organizations/ORG_ID/vouchers/VOUCHER_ID/usages?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao voucher:read.

Cabecalhos

Authorization
string
required
Token bearer.

Parametros de Rota

organizationId
string
required
O UUID da organizacao.
voucherId
string
required
O UUID do voucher.

Parametros de Consulta

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

Resposta

data
array
Array de objetos de uso de voucher.
meta
object
Metadados de paginacao.
{
  "data": [
    {
      "voucherUsageId": "019525fe-7e6c-7fe9-e1ad-9b1c3d5f7a9d",
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "discountAmount": 2500,
      "externalRef": "di_stripe_abc",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1
  }
}

Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
500internal_server_errorOcorreu um erro inesperado