Afiliacja
Afiliacja to działalność Allegro mająca na celu wspieranie sprzedaży poprzez współpracę z partnerami, którzy promują oferty dostępne na platformie. To jednocześnie sposób na budowanie widoczności produktów oraz szansa dla partnerów na dodatkowy zarobek w oparciu o rzeczywiste efekty ich działań.
Zasoby z grupy Affiliate wykorzystują scope:
- allegro:api:affiliate:read - umożliwia odczyt danych;
- allegro:api:affiliate:write - umożliwia zarządzanie i edycję danych.
Zakres uprawnień Twojej aplikacji zmienisz z poziomu zakładki Zarządzanie aplikacjami Allegro.
Jak pobrać informacje o konwersji CPS
Aby pobrać listę konwersji CPS (Cost Per Sale) w ramach Allegro Affiliate Business, skorzystaj z GET /affiliate/conversions/cps. Przekaż nagłówek Accept w postaci “application/vnd.allegro.beta.v1+json”.
Listę możesz dostosować do swoich potrzeb za pomocą parametrów:
- orderCreatedAt.gte - minimalna data i godzina utworzenia zamówienia;
- orderCreatedAt.lte - maksymalna data i godzina utworzenia zamówienia;
- lastModifiedAt.gte - minimalna data i godzina ostatniej zmiany konwersji;
- lastModifiedAt.lte - maksymalna data i godzina ostatniej zmiany konwersji;
- status - status konwersji, dostępne wartości: CREATED - utworzona , REJECTED - odrzucona, CONFIRMED - potwierdzona;
- limit - określ liczbę konwersji, jaką chcesz otrzymać w odpowiedzi. Wartość domyślna to 1000, max 10000;
- offset - wskaż miejsce, od którego chcesz pobrać następną porcję danych;
- includePublisherUrlParameters - pole odpowiedzi o nazwie publisherUrlParameters zawiera parametry obecne w linku, z którego została dokonana konwersja. Parametry te przekazywane są w formie mapy, gdzie klucz to nazwa parametru, a wartość odpowiada wartości parametru. Wysyłane są jedynie parametry, których klucze zostały przekazane w parametrze zapytania o nazwie includePublisherUrlParameters, w celu zminimalizowania rozmiaru odpowiedzi.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/affiliate/conversions/cps’ \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.beta.v1+json' \
Przykładowy response:
{
"conversions": [ // lista konwersji
{
"id": "2991e29e-5fbc-46f5-963a-65c326ba65c2", // identyfikator konwersji
"status": "CONFIRMED", // status konwersji, dostępne wartości: CREATED, REJECTED, CONFIRMED
"lastModifiedAt": "2024-11-30T15:17:05.130Z", // data ostatniej zmiany konwersji
"orderCreatedAt": "2024-11-25T15:00:05.150Z", // data utworzenia zamówienia
"quantity": 5, // liczba przedmiotów
"marketplace": { // rynek zamówienia
"id": "allegro-pl"
},
"offer": {
"id": "11223344556", // identyfikator oferty
"category": {
"id": "257929" // kategoria
},
"unitPrice": { // cena jednostkowa
"amount": "100.00", // kwota
"currency": "PLN" // waluta
},
"seller": {
"login": "login" // login sprzedawcy
}
},
"commission": {
"publisher": { // prowizja wydawcy
"amount": "1.00", // kwota
"currency": "PLN" // waluta
},
"allegro": { // prowizja Allegro
"amount": "10.00", // kwota
"currency": "PLN" // waluta
}
},
"publisherUrlParameters": { // parametry obecne w linku, z którego została dokonana konwersja. Wysyłane są jedynie parametry,
"param1": "value1", // których klucze zostały przekazane w parametrze zapytania "includePublisherUrlParameters".
"param2": "value2",
"param3": "value3"
}
}
]
}