Listar Vouchers

Listar Vouchers

curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/vouchers \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "ext_ref_abc123",
      "name": "Welcome Credit",
      "amount": 10000,
      "currency": "BRL",
      "effectiveAt": "2026-01-01T00:00:00.000Z",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "amountRedeemed": 2500,
      "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": 2, "totalPages": 1 }
}

GET

organizations

{organizationId}

vouchers

Listar Vouchers

curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/vouchers \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "ext_ref_abc123",
      "name": "Welcome Credit",
      "amount": 10000,
      "currency": "BRL",
      "effectiveAt": "2026-01-01T00:00:00.000Z",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "amountRedeemed": 2500,
      "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": 2, "totalPages": 1 }
}

Requer permissao voucher:read.

Headers

Authorization

string

required

Bearer token.

Parametros de Path

organizationId

string

required

UUID da organizacao.

Parametros de Query

page

integer

Numero da pagina.

limit

integer

Resultados por pagina.

status

string

Filtrar por status.

sortBy

string

Campo de ordenacao.

sortOrder

string

Direcao da ordenacao.

Resposta

data

array

Lista de vouchers.

Show propriedades do voucher

voucherId

string

UUID do voucher.

organizationId

string

UUID da organizacao.

externalRef

string

Referencia externa.

name

string

Nome do voucher.

amount

integer

Valor do credito em centavos.

currency

string

Codigo da moeda.

effectiveAt

string

Data de vigencia.

expiresAt

string

Data de expiracao.

amountRedeemed

integer

Valor resgatado em centavos.

status

string

Status do voucher.

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.

meta

object

Metadados de paginacao.

Show propriedades do meta

page

integer

Numero da pagina atual.

limit

integer

Resultados por pagina.

totalItems

integer

Numero total de itens.

totalPages

integer

Numero total de paginas.

{
  "data": [
    {
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "ext_ref_abc123",
      "name": "Welcome Credit",
      "amount": 10000,
      "currency": "BRL",
      "effectiveAt": "2026-01-01T00:00:00.000Z",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "amountRedeemed": 2500,
      "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": 2, "totalPages": 1 }
}

Exemplos de Codigo

curl https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/vouchers \
  -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
`404`	`organization.not_found`	Organizacao nao encontrada
`500`	`internal_server_error`	Ocorreu um erro inesperado

O Objeto Uso de Voucher

Buscar Voucher

⌘I

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

Headers

Parametros de Path

Parametros de Query

Resposta

Exemplos de Codigo

Codigos de Erro

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

​Headers

​Parametros de Path

​Parametros de Query

​Resposta

​Exemplos de Codigo

​Codigos de Erro

Headers

Parametros de Path

Parametros de Query

Resposta

Exemplos de Codigo

Codigos de Erro