Skip to main content
GET
Consultar relatório de vendas de afiliação

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from
string<date-time>

Início do período, em ISO 8601. Sem ele, o relatório não recorta início.

to
string<date-time>

Fim do período, em ISO 8601.

productId
string

Restringe o relatório a um produto da empresa.

Minimum string length: 1
offerId
integer

Restringe o relatório a uma oferta.

Required range: x > 0
transactionStatus
enum<string>

Situação das vendas consideradas. Sem filtro, considera todas.

Available options:
paid,
pending,
refund,
chargeback,
refused,
canceled,
expired
paymentMethod
enum<string>

Filtra as vendas por meio de pagamento.

Available options:
pix,
credit_card,
boleto,
multiple_cards

Response

Relatório de vendas de afiliação do período.

Relatório de vendas de afiliação do período.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required