Skip to main content
POST
Exportar vendas em CSV

Authorizations

Authorization
string
header
required

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

Body

application/json
status
enum<string>

Filtra por situação da venda.

Available options:
pending,
infraction,
paid,
refused,
canceled,
refund,
chargeback,
contest,
preCharge,
error,
waiting,
expired
paymentMethod
enum<string>

Filtra por meio de pagamento.

Available options:
pix,
credit_card,
boleto,
multiple_cards
productId
string

Filtra pelas vendas de um produto.

Minimum string length: 1
customerName
string

Filtra pelo nome do comprador.

Minimum string length: 1
customerEmail
string

Filtra pelo e-mail do comprador: casa tanto o e-mail do cadastro do cliente quanto qualquer e-mail usado por ele numa compra. Aceita trecho do endereço e ignora maiúsculas.

Minimum string length: 1
customerDocument
string

Filtra pelo CPF ou CNPJ do comprador, só dígitos e exato — 39053344705, não 390.533.447-05.

Minimum string length: 1
startDate
string<date-time>

Início do período de criação da venda (ISO 8601).

endDate
string<date-time>

Fim do período de criação da venda (ISO 8601).

saleType
enum<string>

Filtra pelo papel da empresa: produtor, afiliado ou coprodutor.

Available options:
producer,
affiliate,
coproduction
purchaseType
enum<string>

Compra única, assinatura ou parcelamento.

Available options:
single,
subscription,
installment
utmSource
string

Filtra pela origem de tráfego gravada no checkout.

Minimum string length: 1
utmMedium
string

Filtra pelo meio de tráfego gravado no checkout.

Minimum string length: 1
utmCampaign
string

Filtra pela campanha gravada no checkout.

Minimum string length: 1
utmContent
string

Filtra pelo conteúdo do anúncio gravado no checkout.

Minimum string length: 1
utmTerm
string

Filtra pelo termo de busca gravado no checkout.

Minimum string length: 1

Response

Planilha gerada.

Planilha gerada.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required