Listagem de chargebacks
Obtém uma lista detalhada de chargebacks com base nos filtros fornecidos
Required scopes:myeduzz_sales_read
GET
https://api.eduzz.com/myeduzz/v1/sales/chargebacks
Query params
page
number
Página atual
itemsPerPage
number
Número de itens por página
startDate
datetime
Data de início dos chargebacks
endDate
datetime
Data de término dos chargebacks
idNullable
number
Id da venda
chargebackStatusNullable
enum
Status do chargeback
new
won
lost
waitingDocuments
inAnalysis
buyerEmailNullable
string
Email 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
Itens de venda
items[n].id
string
Id da venda
items[n].total
object
Total da venda
items[n].total.currency
string
Moeda
items[n].total.value
number
Valor
items[n].chargeback
object
Dados do chargeback
items[n].chargeback.requestedAt
datetime
Data de solicitação do chargeback
items[n].chargeback.limitDateNullable
datetime
Data limite do chargeback
items[n].chargeback.documentsUploadedAtNullable
datetime
Data de upload dos documentos comprovantes do chargeback
items[n].chargeback.status
enum
Status do chargeback
new
won
lost
waitingDocuments
inAnalysis
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].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].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
Status codes
Status | Descrição |
200 | Success |
Exemplos
1curl --request GET \
2 --url 'https://api.eduzz.com/myeduzz/v1/sales/chargebacks' \
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 "total": {
10 "currency": "BRL",
11 "value": 1000
12 },
13 "chargeback": {
14 "requestedAt": "2023-01-02T12:00:00.000Z",
15 "limitDate": "2023-01-04T12:00:00.000Z",
16 "documentsUploadedAt": "2023-01-03T12:00:00.000Z",
17 "status": "lost"
18 },
19 "affiliate": {
20 "id": "123",
21 "name": "Afiliado Exemplo"
22 },
23 "product": {
24 "id": "4",
25 "name": "Produto Exemplo",
26 "type": "digital",
27 "sku": "5"
28 },
29 "buyer": {
30 "id": "13",
31 "name": "Buyer Example",
32 "email": "buyer@example.com",
33 "document": "12345678900",
34 "phone": "11999999999"
35 }
36 }
37 ]
38}