Skip to main content
GET
Consultar cupons

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Query Parameters

id
integer

Identificador interno do cupom. Não pode ser combinado com codigo.

Example:

1042

codigo
string

Código do cupom, com até 21 caracteres e sem emojis. Não pode ser combinado com id. Pode retornar mais de um cupom, porque o mesmo código pode ter sido cadastrado em cupons diferentes.

Example:

"DESCONTO10"

status
enum<string>

Filtra os cupons pela vigência.

Available options:
ativo,
inativo,
aguardo
Example:

"ativo"

pagina
integer
default:1

Página da listagem, com 10 cupons por página. Padrão 1.

Required range: x >= 1
Example:

1

Response

Sucesso

The response is of type object.