Developer HubDeveloper Hub

Listagem

GET
https://api.eduzz.com/myeduzz/v1/sales
Required scopes:myeduzz_sales_read

Obtém uma lista detalhada de vendas com base nos filtros fornecidos

Query params

page
number

Página atual

itemsPerPage
number

Número de itens por página

startDate
datetime

Data de início das vendas

endDate
datetime

Data de término das vendas

referenceDateNullable
enum

Campo de data de referência para consultar as vendas

dueDate
paidAt
createdAt
updatedAt
contractIdNullable
number

Id do contrato

statusNullable
enum

Status da venda

open
processing
paid
canceled
waiting_refund
refunded
duplicated
expired
recovering
waiting_payment
scheduled
negotiated
productIdNullable
number

Id do produto

affiliateIdNullable
number

Id do afiliado

buyerEmailNullable
string

Email do comprador

buyerDocumentNullable
string

CPF ou CNPJ do comprador

Response params (200)

pages
number

Número de páginas

page
number

Página atual

itemsPerPage
number

Número máximo de itens por página

totalItems
number

Número total de items

items
array of object
items[n].id
string

Id da venda

items[n].contractIdNullable
string

Id do contrato da venda

items[n].status
enum

Status da venda

open
processing
paid
canceled
waiting_refund
refunded
duplicated
expired
recovering
waiting_payment
scheduled
negotiated
items[n].grossGain
object

Ganho bruto da venda

items[n].grossGain.currency
string

Moeda

items[n].grossGain.value
number

Valor

items[n].netGain
object

Ganho líquido da venda

items[n].netGain.currency
string

Moeda

items[n].netGain.value
number

Valor

items[n].partnersGain
object

Ganhos de parceiros da venda

items[n].partnersGain.currency
string

Moeda

items[n].partnersGain.value
number

Valor

items[n].affiliatesGain
object

Ganhos de afiliados da venda

items[n].affiliatesGain.currency
string

Moeda

items[n].affiliatesGain.value
number

Valor

items[n].feeNullable
object

Taxa da venda

items[n].fee.currency
string

Moeda

items[n].fee.value
number

Valor

items[n].total
object

Total da venda

items[n].total.currency
string

Moeda

items[n].total.value
number

Valor

items[n].totalInterest
object

Total com juros da venda

items[n].totalInterest.currency
string

Moeda

items[n].totalInterest.value
number

Valor

items[n].installments
number

Número de parcelas da venda

items[n].alumyFeeNullable
object

Taxa Alumy da venda

items[n].alumyFee.currency
string

Moeda

items[n].alumyFee.value
number

Valor

items[n].others
object

Outras taxas da venda

items[n].others.currency
string

Moeda

items[n].others.value
number

Valor

items[n].currency
string

Moeda da venda

items[n].locale
string

Localidade da venda

items[n].dueDate
datetime

Data de vencimento da venda

items[n].paidAtNullable
datetime

Data de pagamento da venda

items[n].creditDateNullable
datetime

Data de crédito da venda

items[n].isInfiniteFunnel
boolean

Indica se a venda é de um funil infinito

items[n].paymentMethod
enum

Método de pagamento da venda

bankslip
creditcard
pix
unknown
items[n].recoveringStatus
enum

Status de recuperação da venda

inactive
active
canceled
items[n].trackerNullable
string

Rastreador da venda

items[n].tracker2Nullable
string

Rastreador 2 da venda

items[n].tracker3Nullable
string

Rastreador 3 da venda

items[n].createdAt
datetime

Data de criação da venda

items[n].updatedAt
datetime

Data da última atualização da venda

items[n].product
object

Dados do produto

items[n].product.id
string

Id do produto

items[n].product.name
string

Nome do produto

items[n].product.type
enum

Tipo do produto

digital
physical
service
ticket
ecommerce
package
project
items[n].product.skuNullable
string

Sku do produto

items[n].refundNullable
object

Dados do reembolso

items[n].refund.type
enum

Tipo do reembolso

common
partial
items[n].refund.value
object

Valor do reembolso

items[n].refund.value.currency
string

Moeda

items[n].refund.value.value
number

Valor

items[n].refund.partialValue
object

Valor parcial do reembolso

items[n].refund.partialValue.currency
string

Moeda

items[n].refund.partialValue.value
number

Valor

items[n].refund.refundedAtNullable
datetime

Data do reembolso

items[n].affiliateNullable
object

Dados do afiliado

items[n].affiliate.id
string

Id do afiliado

items[n].affiliate.name
string

Nome do afiliado

items[n].recipient
object

Dados do recebedor

items[n].recipient.id
string

Id do recebedor

items[n].recipient.name
string

Nome do recebedor

items[n].recipient.email
string

Email do recebedor

items[n].recipient.document
string

Documento do recebedor

items[n].recipient.phone
string

Telefone do recebedor

items[n].buyer
object

Dados do comprador

items[n].buyer.id
string

Id do comprador

items[n].buyer.name
string

Nome do comprador

items[n].buyer.email
string

Email do comprador

items[n].buyer.document
string

Documento do comprador

items[n].buyer.phone
string

Telefone do comprador

items[n].producer
object

Dados do produtor

items[n].producer.id
string

Id do produtor

items[n].producer.name
string

Nome do produtor

items[n].utmNullable
object

Dados dos parâmetros utm recebidos no checkout por queryString

items[n].utm.source
string

Fonte utm

items[n].utm.campaign
string

Campanha utm

items[n].utm.medium
string

Meio utm

items[n].utm.content
string

Conteúdo utm

Status codes

StatusDescrição
200Success

Exemplos

1curl --request GET \
2	--url https://api.eduzz.com/myeduzz/v1/sales \
3	--header 'Accept: application/json' \
4	--header 'Content-Type: application/json' \
5	--header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'
Response
1{
2  "pages": 1,
3  "page": 1,
4  "itemsPerPage": 10,
5  "totalItems": 1,
6  "items": [
7    {
8      "id": "123456",
9      "contractId": "78910",
10      "status": "paid",
11      "grossGain": {
12        "currency": "BRL",
13        "value": 1000
14      },
15      "netGain": {
16        "currency": "BRL",
17        "value": 900
18      },
19      "partnersGain": {
20        "currency": "BRL",
21        "value": 50
22      },
23      "affiliatesGain": {
24        "currency": "BRL",
25        "value": 50
26      },
27      "fee": {
28        "currency": "BRL",
29        "value": 10
30      },
31      "total": {
32        "currency": "BRL",
33        "value": 1000
34      },
35      "totalInterest": {
36        "currency": "BRL",
37        "value": 5
38      },
39      "installments": 3,
40      "alumyFee": {
41        "currency": "BRL",
42        "value": 5
43      },
44      "others": {
45        "currency": "BRL",
46        "value": 2
47      },
48      "currency": "BRL",
49      "locale": "pt-BR",
50      "dueDate": "2023-12-31T23:59:59Z",
51      "paidAt": "2023-01-01T12:00:00Z",
52      "creditDate": "2023-01-02T12:00:00Z",
53      "isInfiniteFunnel": false,
54      "paymentMethod": "creditcard",
55      "recoveringStatus": "inactive",
56      "tracker": "tracker1",
57      "tracker2": "tracker2",
58      "tracker3": "tracker3",
59      "createdAt": "2023-01-01T00:00:00Z",
60      "updatedAt": "2023-01-02T00:00:00Z",
61      "product": {
62        "id": "4",
63        "name": "Produto Exemplo",
64        "type": "digital",
65        "sku": "5"
66      },
67      "refund": {
68        "type": "common",
69        "value": {
70          "currency": "BRL",
71          "value": 100
72        },
73        "partialValue": {
74          "currency": "BRL",
75          "value": 50
76        },
77        "refundedAt": "2023-01-03T12:00:00Z"
78      },
79      "affiliate": {
80        "id": "123",
81        "name": "Afiliado Exemplo"
82      },
83      "recipient": {
84        "id": "456",
85        "name": "recipient Example",
86        "email": "recebedor@example.com",
87        "document": "12345678900",
88        "phone": "11999999999"
89      },
90      "buyer": {
91        "id": "13",
92        "name": "Buyer Example",
93        "email": "buyer@example.com",
94        "document": "12345678900",
95        "phone": "11999999999"
96      },
97      "producer": {
98        "id": "5",
99        "name": "Producer Name Example"
100      },
101      "utm": {
102        "source": "google",
103        "campaign": "campaing2023",
104        "medium": "cpc",
105        "content": "contect"
106      }
107    }
108  ]
109}
AnteriorDetalhes
PróximaResumo