Skip to main content
GET
Listar descontos

Autorizações

Authorization
string
header
obrigatório

Token de acesso opaco emitido pela API de autenticação (POST /authentication/v1/oauth/token).

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Id (UUID) da loja na plataforma. A loja precisa estar autorizada para o aplicativo.

Parâmetros de consulta

per_page
integer
padrão:30

Itens por página. Padrão 30; valores informados são limitados entre 30 e 250.

Intervalo obrigatório: 30 <= x <= 250
next
string

Cursor da próxima página (valor de X-Next-Cursor). Não pode ser combinado com previous.

previous
string

Cursor da página anterior (valor de X-Previous-Cursor). Não pode ser combinado com next.

Resposta

Página de descontos.

id
string<uuid>
createdAt
string<date-time>
startsAt
string<date-time>
endsAt
string<date-time>

Omitido quando o desconto não tem fim de vigência.

type
enum<string>
Opções disponíveis:
COUPON,
SMART
code
string

Código do cupom. Presente apenas em COUPON.

name
string

Nome do desconto. Presente apenas em SMART.

status
enum<string>

Situação da vigência.

Opções disponíveis:
ACTIVE,
SCHEDULED,
OVERDUE
rules
object
options
enum<string>[]

Omitido quando não há opções.

Opções disponíveis:
CUMULATIVE_WITH_SMART,
NON_PROMOTION_PRODUCTS,
SUBSCRIBER