Access token
Token dostępowy, który jest ważny 12 godzin i pozwala wykonywać operacje na zasobach dostępnych publicznie. Tokeny dostępowe są zgodne ze standardem JWT.
Mimo że tokeny są ważne 12 godzin, nie musisz za każdym razem zmuszać użytkownika do ponownej autoryzacji aplikacji w tym czasie - wystarczy, że zaimplementujesz w swojej aplikacji obsługę refresh tokenów.
Więcej informacji znajdziesz w naszym poradniku.
Cenniki dostaw
Cenniki dostaw ułatwiają zarządzanie cenami dostaw przedmiotów i dzięki nim nie musisz ręcznie uzupełniać cen transportu za każdym razem, gdy wystawiasz ofertę. Wystarczy, że stworzysz cennik, który następnie dodasz do ofert.
Cenniki pomagają w zarządzaniu metodami dostawy. Możesz utworzyć różne szablony, na przykład zależne od rodzaju asortymentu, jaki wystawiasz. Możesz zapisać aż 250 różnych cenników. Każdemu z nich nadasz nazwę, dzięki czemu łatwo je rozróżnisz.
Więcej informacji znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
Centrum Wiadomości
Miejsce komunikowania się kupujących i sprzedających. To połączenie czata i poczty elektronicznej, w którym znajdziesz korespondencję prowadzoną w ramach Allegro, jak i wiadomości od kupujących.
Więcej informacji znajdziesz w naszym poradniku oraz na stronie pomocy Allegro.
Client ID
Identyfikator aplikacji, który otrzymasz wraz z Client Secret po zarejestrowaniu jej na stronie https://apps.developer.allegro.pl/. Client ID jest niezbędny do wygenerowania access tokena. Client ID jednoznacznie identyfikuje aplikację. Każdy request z danej aplikacji powinien przedstawiać się przypisanym do niej Client ID.
Więcej informacji znajdziesz w naszym poradniku.
Client Secret
Hasło aplikacji, które otrzymasz wraz z Client ID po zarejestrowaniu jej na stronie https://apps.developer.allegro.pl/. Client Secret zawsze jest stosowany w parze z Client ID w procesie autoryzacji. Nie udostępniaj go osobom postronnym.
Więcej informacji znajdziesz w naszym poradniku.
Dyskusje
Narzędzie, dzięki któremu kupujący mogą wyjaśnić nieporozumienia transakcyjne ze sprzedającym, np. gdy przesyłka do niego nie dotarła, kiedy produkt został uszkodzony lub gdy otrzymał produkt inny niż ten, który faktycznie zamówił.
Więcej informacji na ten temat znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
Dzienniki zdarzeń
Są to zasoby, w których w czasie rzeczywistym zwracamy zdarzenia, informujące o ostatnich zmianach np. w ofercie. Aktualnie udostępniamy trzy rodzaje dzienników zdarzeń:
- GET /order/events - który dotyczy zamówień. Za jego pomocą możesz monitorować takie akcje kupującego jak:
- zakup,
- wypełnienie formularza opcji dostawy (FOD),
- anulowanie płatności,
- realizacja dopłaty,
- anulowanie zamówienia,
- zmiana statusu zamówienia. Więcej informacji znajdziesz w naszym poradniku.
- GET /sale/offer-events - który dotyczy ofert zalogowanego sprzedawcy. Zwracamy w nim informacje z ostatnich 24 godzin o:
- wystawieniu oferty,
- zmianie w ofercie,
- zmianie liczby sztuk w ofercie - zwracany również po zakupie,
- zmianie ceny w ofercie,
- zakończeniu oferty,
- zarchiwizowaniu oferty,
- złożeniu oferty w licytacji,
- wycofaniu oferty w licytacji.
- GET /sale/category-events - który dotyczy kategorii. Za jego pomocą pobierzesz informacje o zmianach w kategoriach, które wydarzyły się w ostatnich 3 miesiącach, takie jak:
- utworzenie nowej kategorii,
- zmiana nazwy kategorii,
- przeniesienie kategorii w inne miejsce w drzewie kategorii,
- usunięcie kategorii.
Kampanie
Ofertę możesz wyróżnić na liście ofert, przypisując ją do odpowiedniej kampanii. Dzięki temu zyska ona specjalne oznaczenie, np. jeśli zgłosisz ofertę do Strefy Okazji, zyskasz oznaczenie “Okazja” na liście ofert oraz przekreśloną cenę. Innym przykładem oznaczenia jest np. “HIT”, “Nowość”, “Wyprzedaż”, a także oznaczenia sezonowe, jak np. “Black Week” lub “Zimowa wyprzedaż”.
Więcej informacji znajdziesz w naszym poradniku oraz na stronach dla sprzedających:
Katalog Produktów
To stworzona przez nas baza produktów, z którymi sprzedający powinni wiązać swoje oferty. Kupujący na Allegro mogą przeglądać miliony ofert wystawianych przez sprzedających. Oferty te mogą różnić się ceną i warunkami sprzedaży, ale sprzedawany produkt pozostaje ten sam.
W ramach Katalogu produktów Allegro chcemy zebrać i opisać wszystkie produkty, które są dostępne w ofertach wystawianych przez sprzedających. Katalogujemy produkty, które odróżniają się od innych swoimi właściwościami, np. modelem, kodem producenta, numerem GTIN, czy innymi parametrami podstawowymi.
Produkty w naszym katalogu wyszukasz za pomocą GET /sale/products. Więcej informacji znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
Oferta
Oferta zawiera informacje zarówno o przedmiocie, który wystawia sprzedający, ale także uwzględnia indywidualne informacje, zależne od danego sprzedającego, takie jak:
- cena,
- liczba dostępnych sztuk,
- format sprzedaży (np. Kup Teraz),
- warunki zwrotów i reklamacji,
- czas trwania,
- czas wysyłki,
- opcje faktury,
- cennik dostawy.
Tym właśnie oferta różni się od produktu. Podczas, gdy produkt posiada własny zestaw cech, na podstawie których odróżniamy go od innego produktu, oferta zawiera dodatkowe dane, które wpływają na ostateczną decyzję klienta o zakupie. Tym samym z jednym produktem, np. konkretnym modelem telefonu, może być połączonych wiele ofert, które zostały wystawione przez różnych sprzedających.
Ofertę utworzysz za pomocą POST /sale/offers lub POST /sale/product-offers. Dane oferty zwracamy do 60 dni po zakończeniu publikacji - po tym czasie przeniesiemy ją do archiwum.
Ofertę możesz promować, a także przypisać do kampanii.
Więcej informacji znajdziesz w naszych poradnikach:
Oferty wielowariantowe
Oferty wielowariantowe to zbiór połączonych ofert tego samego produktu w różnych wariantach. Najczęściej warianty produktu różnią się kolorem, rozmiarem, wagą, np. ten sam model butów, ale w różnych rozmiarach. Oferty wielowariantowe możesz tworzyć manualnie, a w wybranych kategoriach robimy to automatycznie.
Więcej informacji znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
One Fulfillment by Allegro
One Fulfillment by Allegro to usługa kompleksowej obsługi logistycznej dla e-commerce. W ramach niej sprzedawcy wyślą do centrum logistycznego Allegro swoje towary, a my zajmiemy się ich przechowywaniem oraz obsługą zamówień i zapytań posprzedażowych ich klientów.
Więcej informacji o One Fulfillment by Allegro oraz o tym, jak z skorzystać z tej usługi, znajdziesz na naszej stronie. Obsługę tego procesu w ramach API opisaliśmy w naszym poradniku.
Opcje promowania
Każdą ofertę możesz wypromować, dzięki czemu przyciągniesz do niej więcej kupujących. Udostępniamy poniższe opcje promowania:
- Wyróżnienie Elastyczne, za które opłatę naliczamy codziennie;
- Wyróżnienie, za które opłatę naliczamy co dziesięć dni;
- Pakiet Promo (Wyróżnienie + Podświetlenie + Pogrubienie), dla którego opłatę naliczamy codziennie;
- Promowanie na stronie działu - opcja dodatkowa, opłatę naliczamy co dziesięć dni.
Więcej informacji znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
Powiązane aplikacje
Zakładka, w której użytkownicy znajdą aplikacje zewnętrzne połączone z ich kontem Allegro. Mogą przez nią usunąć powiązanie konta z daną aplikacją, dzięki czemu wycofają zgodę dla aplikacji, by wykonywała działania w ich imieniu.
Produkt
Przedmiot, który wystawiasz na sprzedaż w ofercie. Posiada on swoje indywidualne cechy, które jednoznacznie go identyfikują, jak np. parametry lub numer EAN. Do jednego produktu może być przypisanych wiele ofert, które pochodzą od różnych sprzedających.
Więcej informacji znajdziesz w naszych poradnikach:
Rabat transakcyjny
Zwrot prowizji, o który może wystąpić sprzedawca, jeśli sprzeda przedmiot, ale transakcja nie dojdzie do skutku.
Więcej informacji znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
Refresh token
Token, który przedłuża ważność autoryzacji użytkownika dla aplikacji. Otrzymujesz go w parze razem z access tokenem, który jest ważny 12 godzin. Żeby jednak nie zmuszać użytkownika do ponownej autoryzacji dwa razy na dobę, możesz korzystać właśnie z refresh tokenów.
Więcej informacji znajdziesz w naszym poradniku.
Sandbox
Allegro Sandbox to środowisko testowe Allegro. Możesz na nim bezpiecznie testować REST API platformy Allegro. Środowisko odwzorowuje wszystkie najważniejsze funkcje serwisu Allegro - możesz m.in.:
- utworzyć i aktywować konto,
- wystawić ofertę,
- przejść cały proces zakupowy,
- korzystać z wyszukiwarki,
- wystawić ocenę sprzedawcy.
Dzięki symulatorowi sprawdzisz na nim również szybkie płatności online. Więcej informacji znajdziesz w naszym poradniku.
Scope
Scope’y to zakresy określające poziom uprawnień do korzystania z API Allegro. Każdy zakres ma przypisany zestaw uprawnień, który definiuje:
- zestaw zasobów, do których można uzyskać dostęp za pomocą scope’a,
- zestaw operacji, które można wykonać w scope’ie.
Scope’y określasz na etapie autoryzacji użytkownika. Poniżej znajdziesz przykładowy request, który pozwoli aplikacji na dostęp tylko do zasobów do zarządzania ofertami oraz odczytu zamówień:
../auth/oauth/authorize?response_type=code&redirect_uri=www.example.com&client_id=438f71d3a26e4d829783a0a621873465& scope=allegro:api:sale:offers:write%20allegro:api:orders:read
Ekran zgody, który widzi użytkownik, będzie w tym przypadku wyglądać następująco:
Pełną listę dostępnych scope’ów znajdziesz w naszym poradniku.
Serwis bazowy
Serwis przypisany do kraju, w którym sprzedający się zarejestrował, np. dla sprzedającego, który zarejestrował się na polskiej domenie allegro.pl, jest to serwis allegro-pl. Identyfikator serwisu bazowego użytkownika zwracamy w polu "baseMarketplace.id" w odpowiedzi dla GET /me.
Więcej informacji znajdziesz w naszym poradniku.
Serwis dodatkowy
Pozostałe serwisy Allegro poza serwisem bazowym, na których sprzedawcy mogą wyświetlać oferty, np. dla sprzedających, dla których serwisem bazowym jest allegro-pl, serwisem dodatkowym jest allegro-cz. Analogicznie, serwisem dodatkowym dla serwisu bazowego allegro-cz, jest serwis allegro-pl oraz inne serwisy Allegro, które uruchomimy w przyszłości.
Za pomocą GET /marketplaces sprawdzisz ID serwisów, w których użytkownik może wyświetlić swoje oferty. Znajdziesz tu również inne dane, które dotyczą konkretnego serwisu, np. języki, w jakich oferta może być utworzona, a także wyświetlona kupującemu, dostępne waluty oraz kraje dostawy.
Więcej informacji znajdziesz w naszym poradniku.
Status zamówienia
Status zamówienia zależy od tego, jakie akcje wykonał kupujący. Wyróżniamy następujące statusy:
- BOUGHT - klient kupił, ale jeszcze nie zapłacił za zamówienie;
- FILLED_IN - klient wypełnił formularz dostawy, ale jeszcze nie opłacił zamówienia;
- READY_FOR_PROCESSING - klient wypełnił formularz dostawy oraz opłacił zamówienie;
- CANCELLED - zamówienie zostało anulowane.
Więcej informacji znajdziesz w naszym poradniku.
Status realizacji zamówienia
W odróżnieniu od statusu zamówienia, który jest nadawany automatycznie na podstawie akcji kupującego, status realizacji zamówienia nadawany jest przez sprzedającego. Dzięki niemu może określić, na jakim etapie aktualnie znajduje się realizacja zamówienia.
Wyróżniamy następujące statusy:
- NEW - nowe,
- PROCESSING - w realizacji,
- READY_FOR_SHIPMENT - do wysłania,
- READY_FOR_PICKUP - do odbioru,
- SENT - wysłane,
- PICKED_UP - odebrane,
- CANCELLED - anulowane.
Więcej informacji znajdziesz w naszym poradniku.
User ID
Unikalny identyfikator, który otrzymuje każdy użytkownik po rejestracji konta, np. 62799754. Otrzymasz go w odpowiedzi dla GET /me, w polu “id”.
Wysyłam z Allegro
To narzędzie, które ułatwia zarządzanie przesyłkami w Allegro. Sprzedawcy mogą utworzyć w nim i wydrukować etykiety oraz zamówić odbiór paczek przez przewoźników ze wskazanego adresu.
Więcej informacji znajdziesz w naszym poradniku oraz na stronie dla sprzedających.
