Allegro REST API

gdzie?

Polska | polski | PLN
  • Informacje podstawowe
  • Główne procesy
  • Uwierzytelnianie i autoryzacja
  • Wzorzec Command
  • Glosariusz
  • Lista metod
  • Pierwsze kroki
  • Wystawianie oferty z produktem
  • Serwisy zagraniczne Allegro
  • Zarządzanie ofertami
  • Oferty wielowariantowe
  • Pasuje do
  • Zarządzanie zgłoszeniami ofert do kampanii
  • Rabaty i promocje
  • Zamówienia
  • Wysyłam z Allegro
  • One Fulfillment by Allegro
  • Dyskusje
  • Konto i dane użytkownika
  • Centrum wiadomości
  • Sprawdzanie opłat
  • Wystawianie ogłoszeń
  • Publiczne oferty
FAQ
  • Aktualności
  • Changelog
Dokumentacja
Regulamin
Kontakt
  • Moje aplikacje
  • Moje aplikacje (sandbox)
  • Newsletter
  1. Allegro REST API
  2. Główne procesy
Wystawienie oferty powiązanej z produktem
Zarządzanie ofertą
Promowanie oferty
Obsługa zamówień i zwrotów
Zarządzanie przesyłkami przez Wysyłam z Allegro
Zarządzanie komunikacją z klientami

Główne procesy

Poniżej znajdziesz opis głównych procesów, które obsłużysz za pomocą Allegro API. Zbiór wszystkich zasobów, znajdziesz natomiast w naszej dokumentacji.

Za najważniejsze procesy, które z perspektywy Allegro powinny zostać obsłużone w integracji w pierwszej kolejności, uważamy:

  • wystawianie, zarządzanie i promowanie ofert,
  • obsługa zamówień i zwrotów,
  • zarządzanie komunikacją z klientami.

Wystawienie oferty powiązanej z produktem

Za pomocą zasobów /sale/product-offers w łatwy sposób, za pomocą jednego żądania, wystawisz aktywną ofertę powiązaną z produktem. Jeśli wskażesz nam dany produkt lub na podstawie przekazanych danych rozpoznamy, że produkt istnieje w naszej bazie, to pobierzemy jego dane i uwzględnimy je w wystawionej ofercie.

W naszym poradniku szczegółowo opisaliśmy, jak wystawić ofertę powiązaną z produktem, a poniżej znajdziesz listę podstawowych zasobów związanych procesem:

  • POST /sale/product-offers - utwórz ofertę powiązaną z produktem,
  • GET /sale/products - wyszukaj produkt,
  • GET /sale/product-offers/{offerId} - pobierz szczegóły oferty,
  • GET /sale/product-offers/{offerId}/operations/{operationId} - sprawdź status publikacji / edycji oferty.

Zarządzanie ofertą

Każdą ofertę możesz edytować (prócz zarchiwizowanej), np. zmienić cenę przedmiotu, liczbę dostępnych sztuk lub status publikacji. Za pomocą dziennika zdarzeń możesz także śledzić modyfikacje w ofertach zalogowanego sprzedawcy, które wydarzyły się w ciągu ostatnich 24 godzin.

Na stronie dla sprzedających wymieniliśmy zakres danych, które możesz edytować w aktywnej ofercie, wraz z informacją, kiedy jest to możliwe.

W naszym poradniku szczegółowo opisaliśmy, jak zarządzać ofertą, a poniżej znajdziesz listę podstawowych zasobów związanych procesem:

  • GET /sale/offer-events - pobierz dziennik zdarzeń w ofertach,
  • GET /sale/offers - pobierz listę ofert,
  • GET sale/offers/{offerId} - pobierz szczegółowe dane oferty,
  • PUT /sale/offers/{offerId} - edytuj ofertę,
  • PATCH /sale/product-offers/{offerId} - edytuj ofertę (zamiast całej struktury, możesz przekazać wyłącznie te pola, które chcesz edytować),
  • PUT /sale/offer-price-change-commands/{commandId} - zmień grupowo cenę w ofertach,
  • PUT /sale/offer-quantity-change-commands/{commandId} - zmień grupowo liczbę przedmiotów w ofertach,
  • PUT /sale/offer-modification-commands/{commandId} - zmień grupowo np. cenniki dostaw,
  • PUT /sale/offer-publication-commands/{commandId} - zakończ lub wznów ofertę.

Promowanie oferty

Ofertę możesz przypisać do jednej z kampanii marketingowych Allegro, dzięki czemu zyska specjalne oznaczenie i tym samym może wzbudzić większe zainteresowanie wśród kupujących.

W naszym poradniku szczegółowo opisaliśmy, jak przypisać ofertę do kampanii, a poniżej znajdziesz listę podstawowych zasobów związanych z procesem:

  • GET /sale/badge-campaigns - pobierz listę dostępnych kampanii,
  • POST /sale/badges - zgłoś ofertę do danego oznaczenia,
  • GET /sale/badge-applications/{applicationId} - pobierz szczegóły danego zgłoszenia.

Obsługa zamówień i zwrotów

W ramach zasobów do obsługi zamówień pobierzesz wszelkie dane potrzebne do realizacji zamówienia, a także wykonasz akcje posprzedażowe, jak np. zwrot płatności do kupującego czy wniosek o zwrot prowizji w przypadku, gdy transakcja ostatecznie nie dojdzie do skutku.

W naszym poradniku szczegółowo opisaliśmy, jak obsługiwać zamówienia, a poniżej znajdziesz listę podstawowych zasobów związanych z procesem:

  • GET /order/events - pobierz dziennik zdarzeń,
  • GET /order/event-stats - pobierz informacje o ostatnim zdarzeniu,
  • GET /order/checkout-forms/{id} - pobierz szczegóły zamówienia,
  • PUT /order/checkout-forms/{id}/fulfillment - zmień status realizacji zamówienia,
  • POST /order/checkout-forms/{id}/shipments - dodaj numer przesyłki do zamówienia,
  • GET /order/customer-returns/{customerReturnId} - pobierz szczegółowe informacje o zwrocie,
  • POST /order/customer-returns/{customerReturnId}/rejection - odmów zwrotu wpłaty,
  • POST /payments/refunds - zrealizuj zwrot płatności,
  • POST /order/refund-claims - utwórz wniosek o rabat transakcyjny.

Zarządzanie przesyłkami przez Wysyłam z Allegro

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.

W naszym poradniku szczegółowo opisaliśmy jak zarządzać przesyłkami w ramach Wysyłam z Allegro, a poniżej znajdziesz listę podstawowych zasobów związanych z procesem:

  • GET /parcel-management/delivery-services - pobierz listę dostępnych usług dostawy,
  • PUT /parcel-management/parcel-create-commands/{commandId} - utwórz nową paczkę,
  • GET parcel-management/parcel-create-commands/{commandId} - sprawdź status utworzenia paczki,
  • GET /parcel-management/parcels/{parcelId} - pobierz szczegółowe dane paczki,
  • PUT parcel-management/parcel-cancel-commands/{commandId} - anuluj paczkę,
  • GET /parcel-management/parcel-cancel-commands/{commandId} - sprawdź status anulowania paczki,
  • GET /parcel-management/pickup-date-proposals - pobierz propozycje dat i godzin odbioru paczek przez kuriera,
  • PUT /parcel-management/parcel-pickup-request-commands/{commandId} - zamów odbiór paczek przez kuriera,
  • GET /parcel-management/parcel-pickup-request-commands{commandId} - sprawdź status zamówienia odbioru paczek,
  • GET /parcel-management/parcels/label - pobierz etykiety,
  • GET /parcel-management/parcels/protocol - pobierz protokoły nadania.

Zarządzanie komunikacją z klientami

W ramach zasobów do obsługi dyskusji sprzedający mogą łatwo nawiązać kontakt z kupującymi oraz wygodnie i szybko rozwiązać problem transakcyjny.

W naszym poradniku szczegółowo opisaliśmy, jak zarządzać dyskusjami, a poniżej znajdziesz listę podstawowych zasobów związanych z procesem:

  • GET /sale/disputes - pobierz wszystkie dyskusje,
  • GET /sale/disputes/{disputeId} - pobierz szczegółowe informacje o danej dyskusji,
  • GET/sale/disputes/{disputeId}/messages - pobierz listę wiadomości z dyskusji,
  • GET /sale/dispute-attachments/{attachmentId} - pobierz załącznik,
  • POST /sale/disputes/{disputeId}/messages - dodaj wiadomość,
  • POST /sale/dispute-attachments - dodaj deklarację załącznika,
  • PUT /sale/dispute-attachments/{attachmentId} - dodaj załącznik do dyskusji.

Zgłoś błąd lub zasugeruj zmianę

Czy ten artykuł był dla Ciebie przydatny?