Resumo
GET
https://api.eduzz.com/myeduzz/v1/sales/summary
Required scopes:myeduzz_sales_read
Retorna um relatório sumarizado com o total realizado em vendas com base nos filtros fornecidos.
Query params
startDate
datetime
Data de início das vendas
endDate
datetime
Data de término das vendas
contractIdNullable
number
Id do contrato
productIdNullable
number
Id do produto
affiliateIdNullable
number
Id do afiliado
statusNullable
enum
Status da venda
open
processing
paid
canceled
waiting_refund
refunded
duplicated
expired
recovering
waiting_payment
scheduled
negotiated
Response params (200)
discount
object
Descontos da venda
discount.currency
string
Moeda
discount.value
number
Valor
grossGain
object
Ganho bruto da venda
grossGain.currency
string
Moeda
grossGain.value
number
Valor
netGain
object
Ganho líquido da venda
netGain.currency
string
Moeda
netGain.value
number
Valor
partnersGain
object
Ganhos de parceiros da venda
partnersGain.currency
string
Moeda
partnersGain.value
number
Valor
affiliatesGain
object
Ganhos de afiliados da venda
affiliatesGain.currency
string
Moeda
affiliatesGain.value
number
Valor
fee
object
Taxa da venda
fee.currency
string
Moeda
fee.value
number
Valor
others
object
Outras taxas da venda
others.currency
string
Moeda
others.value
number
Valor
total
object
Total da venda
total.currency
string
Moeda
total.value
number
Valor
Status codes
| Status | Descrição |
| 200 | Success |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v1/sales/summary \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'Response
1{
2 "discount": {
3 "currency": "BRL",
4 "value": 100
5 },
6 "grossGain": {
7 "currency": "BRL",
8 "value": 1000
9 },
10 "netGain": {
11 "currency": "BRL",
12 "value": 780
13 },
14 "partnersGain": {
15 "currency": "BRL",
16 "value": 50
17 },
18 "affiliatesGain": {
19 "currency": "BRL",
20 "value": 50
21 },
22 "fee": {
23 "currency": "BRL",
24 "value": 10
25 },
26 "others": {
27 "currency": "BRL",
28 "value": 10
29 },
30 "total": {
31 "currency": "BRL",
32 "value": 1000
33 }
34}