Detalhes

GET

https://api.eduzz.com/myeduzz/v1/sales/:id

Required scopes:myeduzz_sales_read

Obtém detalhes de uma venda específica

Path params

Id da venda que se deseja obter os detalhes

Response params (200)

string

Id da venda

contractIdNullable

string

Id do contrato da venda

status

enum

Status da venda

open

processing

paid

canceled

waiting_refund

refunded

duplicated

expired

recovering

waiting_payment

scheduled

negotiated

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

feeNullable

object

Taxa da venda

fee.currency

string

Moeda

fee.value

number

Valor

total

object

Total da venda

total.currency

string

Moeda

total.value

number

Valor

totalInterest

object

Total com juros da venda

totalInterest.currency

string

Moeda

totalInterest.value

number

Valor

installments

number

Número de parcelas da venda

alumyFeeNullable

object

Taxa Alumy da venda

alumyFee.currency

string

Moeda

alumyFee.value

number

Valor

others

object

Outras taxas da venda

others.currency

string

Moeda

others.value

number

Valor

currency

string

Moeda da venda

locale

string

Localidade da venda

dueDate

datetime

Data de vencimento da venda

paidAtNullable

datetime

Data de pagamento da venda

creditDateNullable

datetime

Data de crédito da venda

isInfiniteFunnel

boolean

Indica se a venda é de um funil infinito

paymentMethod

enum

Método de pagamento da venda

bankslip

creditcard

pix

unknown

recoveringStatus

enum

Status de recuperação da venda

inactive

active

canceled

trackerNullable

string

Rastreador da venda

tracker2Nullable

string

Rastreador 2 da venda

tracker3Nullable

string

Rastreador 3 da venda

createdAt

datetime

Data de criação da venda

updatedAt

datetime

Data da última atualização da venda

product

object

Dados do produto

product.id

string

Id do produto

product.name

string

Nome do produto

product.type

enum

Tipo do produto

digital

physical

service

ticket

ecommerce

package

project

product.skuNullable

string

Sku do produto

refundNullable

object

Dados do reembolso

refund.type

enum

Tipo do reembolso

common

partial

refund.value

object

Valor do reembolso

refund.value.currency

string

Moeda

refund.value.value

number

Valor

refund.partialValue

object

Valor parcial do reembolso

refund.partialValue.currency

string

Moeda

refund.partialValue.value

number

Valor

refund.refundedAtNullable

datetime

Data do reembolso

affiliateNullable

object

Dados do afiliado

affiliate.id

string

Id do afiliado

affiliate.name

string

Nome do afiliado

recipient

object

Dados do recebedor

recipient.id

string

Id do recebedor

recipient.name

string

Nome do recebedor

recipient.email

string

Email do recebedor

recipient.document

string

Documento do recebedor

recipient.phone

string

Telefone do recebedor

buyer

object

Dados do comprador

buyer.id

string

Id do comprador

buyer.name

string

Nome do comprador

buyer.email

string

Email do comprador

buyer.document

string

Documento do comprador

buyer.phone

string

Telefone do comprador

buyer.phone2Nullable

string

Telefone 2 do comprador

buyer.phone3Nullable

string

Telefone 3 do comprador

buyer.address

object

Dados do endereço

buyer.address.zipCode

string

Cep do endereço

buyer.address.street

string

Rua do endereço

buyer.address.numberNullable

string

Número do endereço

buyer.address.complementNullable

string

Complemeto do endereço

buyer.address.neighborhood

string

Bairro do endereço

buyer.address.city

string

Cidade do endereço

buyer.address.state

string

Estado do endereço

producer

object

Dados do produtor

producer.id

string

Id do produtor

producer.name

string

Nome do produtor

affiliates

array of object

Dados dos afiliados

affiliates[n].id

string

Id do afiliado

affiliates[n].name

string

Nome do afiliado

affiliates[n].email

string

Email do afiliado

affiliates[n].netGain

object

Ganho líquido do afiliado

affiliates[n].netGain.currency

string

Moeda

affiliates[n].netGain.value

number

Valor

partners

array of object

Dados dos parceiros

partners[n].id

string

Id do parceiro

partners[n].name

string

Nome do parceiro

partners[n].email

string

Email do parceiro

partners[n].netGain

object

Ganho líquido do parceiro

partners[n].netGain.currency

string

Moeda

partners[n].netGain.value

number

Valor

items

array of object

Itens da venda

items[n].id

string

Id do item

items[n].productId

string

Id do produto do item

items[n].description

string

Descrição do item

items[n].unitValue

object

Valor unitário do item

items[n].unitValue.currency

string

Moeda

items[n].unitValue.value

number

Valor

items[n].quantity

number

Quantidade do item

items[n].value

object

Valor total do item

items[n].value.currency

string

Moeda

items[n].value.value

number

Valor

items[n].discountNullable

object

Desconto do item

items[n].discount.currency

string

Moeda

items[n].discount.value

number

Valor

items[n].freightTypeNullable

string

Tipo de frete do item

items[n].freightDeadlineNullable

string

Prazo de entrega do item

items[n].trackingCodeNullable

string

Código de rastreamento do item

utmNullable

object

Dados dos parâmetros utm recebidos no checkout por queryString

utm.source

string

Fonte utm

utm.campaign

string

Campanha utm

utm.medium

string

Meio utm

utm.content

string

Conteúdo utm

Status codes

Status	Descrição
200	Success

Exemplos

1curl --request GET \
2	--url https://api.eduzz.com/myeduzz/v1/sales/123456 \
3	--header 'Accept: application/json' \
4	--header 'Content-Type: application/json' \
5	--header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'

Response

1{
2  "id": "123456",
3  "contractId": "78910",
4  "status": "paid",
5  "grossGain": {
6    "currency": "BRL",
7    "value": 1000
8  },
9  "netGain": {
10    "currency": "BRL",
11    "value": 900
12  },
13  "partnersGain": {
14    "currency": "BRL",
15    "value": 50
16  },
17  "affiliatesGain": {
18    "currency": "BRL",
19    "value": 50
20  },
21  "fee": {
22    "currency": "BRL",
23    "value": 10
24  },
25  "total": {
26    "currency": "BRL",
27    "value": 1000
28  },
29  "totalInterest": {
30    "currency": "BRL",
31    "value": 5
32  },
33  "installments": 3,
34  "alumyFee": {
35    "currency": "BRL",
36    "value": 5
37  },
38  "others": {
39    "currency": "BRL",
40    "value": 2
41  },
42  "currency": "BRL",
43  "locale": "pt-BR",
44  "dueDate": "2023-12-31T23:59:59Z",
45  "paidAt": "2023-01-01T12:00:00Z",
46  "creditDate": "2023-01-02T12:00:00Z",
47  "isInfiniteFunnel": false,
48  "paymentMethod": "creditcard",
49  "recoveringStatus": "inactive",
50  "tracker": "tracker1",
51  "tracker2": "tracker2",
52  "tracker3": "tracker3",
53  "createdAt": "2023-01-01T00:00:00Z",
54  "updatedAt": "2023-01-02T00:00:00Z",
55  "product": {
56    "id": "1",
57    "name": "Product Example 1",
58    "type": "digital",
59    "sku": "5"
60  },
61  "refund": {
62    "type": "common",
63    "value": {
64      "currency": "BRL",
65      "value": 100
66    },
67    "partialValue": {
68      "currency": "BRL",
69      "value": 50
70    },
71    "refundedAt": "2023-01-03T12:00:00Z"
72  },
73  "affiliate": {
74    "id": 123,
75    "name": "Affiliate Example"
76  },
77  "recipient": {
78    "id": "456",
79    "name": "Example Recipient",
80    "email": "examplerecipient@example.com",
81    "document": "12345678900",
82    "phone": "11999999999"
83  },
84  "buyer": {
85    "id": "3",
86    "name": "Buyer Example",
87    "email": "buyer@example.com",
88    "document": "12345678900",
89    "phone": "11999999999",
90    "phone2": "11888888888",
91    "phone3": "11777777777",
92    "address": {
93      "zipCode": "12345678",
94      "street": "Street Example",
95      "number": "123",
96      "complement": "number 101",
97      "neighborhood": "Neighborhood Example",
98      "city": "City Example",
99      "state": "SP"
100    }
101  },
102  "producer": {
103    "id": "2",
104    "name": "Producer Example"
105  },
106  "affiliates": [
107    {
108      "id": "4",
109      "name": "Affiliates 1",
110      "email": "affiliate1@example.com",
111      "netGain": {
112        "currency": "BRL",
113        "value": 50
114      }
115    }
116  ],
117  "partners": [
118    {
119      "id": "6",
120      "name": "Partners 1",
121      "email": "partner@example.com",
122      "netGain": {
123        "currency": "BRL",
124        "value": 50
125      }
126    }
127  ],
128  "items": [
129    {
130      "id": "7",
131      "productId": "1",
132      "description": "Item Example 7 ",
133      "unitValue": {
134        "currency": "BRL",
135        "value": 500
136      },
137      "quantity": 2,
138      "value": {
139        "currency": "BRL",
140        "value": 1000
141      },
142      "discount": {
143        "currency": "BRL",
144        "value": 50
145      },
146      "freightType": "normal",
147      "freightDeadline": "7 dias",
148      "trackingCode": "TRACK123"
149    }
150  ],
151  "utm": {
152    "source": "google",
153    "campaign": "campaing2023",
154    "medium": "cpc",
155    "content": "contect1"
156  }
157}