Listagem dos Clientes
GET
https://api.eduzz.com/myeduzz/v1/customers
Required scopes:myeduzz_customers_read
Listagem de todos os compradores com base nos filtros fornecidos.
Query params
page
number
Página atual
itemsPerPage
number
Número de itens por página
order
enum
Ordenação dos resultados (ascendente ou descendente)
asc
desc
startDate
datetime
Data de início do período
endDate
datetime
Data de término do período
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 do comprador
items[n].name
string
Nome do comprador
items[n].email
string
E-mail do comprador
items[n].phone
object
Informações de telefone do comprador
items[n].phone.countryCode
string
Código do país
items[n].phone.areaCode
string
Código de área
items[n].phone.number
string
Número
items[n].purchaseHistoryOverview
object
Visão geral do histórico de compras do cliente
items[n].purchaseHistoryOverview.productsQuantity
number
Quantidade de produtos vendidos para o cliente
items[n].purchaseHistoryOverview.net
object
Total de ganhos líquidos em vendas para o cliente
items[n].purchaseHistoryOverview.net.currency
enum
Moeda
BRL
items[n].purchaseHistoryOverview.net.value
number
Valor
items[n].purchaseHistoryOverview.gross
object
Total de ganhos brutos em vendas para o cliente
items[n].purchaseHistoryOverview.gross.currency
enum
Moeda
BRL
items[n].purchaseHistoryOverview.gross.value
number
Valor
Status codes
| Status | Descrição |
| 200 | Success |
| 422 | Erro de validação |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v1/customers \
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 "name": "John Doe",
10 "email": "buyer@teste.com",
11 "phone": {
12 "countryCode": "55",
13 "areaCode": "15",
14 "number": "999999999"
15 },
16 "purchaseHistoryOverview": {
17 "productsQuantity": 10,
18 "net": {
19 "currency": "BRL",
20 "value": 1000
21 },
22 "gross": {
23 "currency": "BRL",
24 "value": 1005
25 }
26 }
27 }
28 ]
29}