Listagem
GET
https://api.eduzz.com/myeduzz/v1/affiliates
Required scopes:myeduzz_affiliates_read
Listagem de todos os afiliados do produtor com base nos filtros fornecidos.
Query params
productIds
string
IDs dos produtos
page
number
Página atual
itemsPerPage
number
Quantidade de afiliados por página
Response params (200)
pages
number
Número de páginas
page
number
Página atual
itemsPerPage
number
Quantidade de afiliados por página
totalItems
number
Total de afiliados encontrados
items
array of object
items[n].id
string
ID da afiliação
items[n].status
enum
Status da afiliação
approved
canceled
pending
removed
items[n].requestedAt
datetime
Data da solicitação de afiliação
items[n].approvedAt
datetime
Data da aprovação de afiliação
items[n].updatedAt
datetime
Data da ultima atualização de afiliação
items[n].createdAt
datetime
Data da criação de afiliação
items[n].product
object
items[n].product.name
string
Nome do produto
items[n].product.id
string
ID do produto
items[n].customer
object
items[n].customer.name
string
Nome do afiliado
items[n].customer.id
string
ID da conta do afiliado na eduzz
Status codes
| Status | Descrição |
| 200 | Success |
| 403 | Missing scope in request headers |
| 404 | Product ID not found |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v1/affiliates \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'\
6 --data '
7{
8 "pages": 1,
9 "page": 1,
10 "itemsPerPage": 10
11}
12'Response
1{
2 "pages": 1,
3 "page": 1,
4 "itemsPerPage": 10,
5 "totalItems": 1,
6 "items": [
7 {
8 "id": "32366478",
9 "status": "approved",
10 "requestedAt": "2024-06-17T17:25:31.000Z",
11 "approvedAt": "2024-06-17T17:25:31.000Z",
12 "updatedAt": "2024-06-17T17:25:32.150Z",
13 "createdAt": "2024-06-17T17:25:31.470Z",
14 "product": {
15 "id": "1739854",
16 "name": "Produto de exemplo"
17 },
18 "customer": {
19 "id": "74452654",
20 "name": "José da Silva"
21 }
22 }
23 ]
24}