Skip to main content
GET
Cupons
Retorna as vendas da loja em que um cupom foi usado: o código do cupom (coupon), o valor da venda (amount), a data (saleDate) e o cliente (customerId). Vendas sem cupom não aparecem aqui — a ausência de uma venda nesta rota não significa que ela não existe.
Para medir o desempenho de um cupom, agrupe pelos valores de coupon: quantas vendas, receita total e quantos clientes distintos usaram. Cruzando customerId com Clientes (CRM), dá para saber se o cupom atraiu clientes novos ou recorrentes.
Filtre pelo período da venda com from/to (datas inclusivas) ou sincronize incrementalmente com updatedSince; pagine com cursor/nextCursor.

Erros

Obter pedido

O pedido completo por trás de cada saleId — itens, valores e modalidade.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.

Parâmetros de consulta

from
string<date>

Início do período (data, inclusive). Deve ser anterior ou igual a to.

to
string<date>

Fim do período (data, inclusive).

updatedSince
string<date-time>

Retorna apenas registros atualizados a partir deste instante (sincronização incremental).

cursor
string

Cursor opaco da próxima página, retornado em nextCursor. Omita na primeira chamada.

limit
integer<int32>
padrão:100

Itens por página. Valores acima de 500 são limitados a 500.

Intervalo obrigatório: x <= 500

Resposta

Página de vendas com cupom do período.

items
object[]
nextCursor
string | null

Cursor da próxima página. Null quando não há próxima página.