Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetSiteJournalDeals

Ostatnia zmiana: 08.05.2012 r.
Dostępność:
Metoda pozwala na pobranie informacji z dziennika zdarzeń na temat zdarzeń (utworzenie aktu zakupowego, utworzenie transakcji, anulowanie transakcji, zakończenie transakcji), związanych z formularzami pozakupowymi w kontekście zalogowanego użytkownika będącego stroną transakcji (dane zwracane są tylko dla ofert użytkownika utworzonych przez niego w kraju do którego jest on zalogowany w momencie wywoływania metody). Zwracanych jest zawsze 100 najnowszych zdarzeń (zaczynając od punktu podanego w parametrze journal-start), posortowanych rosnąco po czasie ich wystąpienia. Aby sterować pobieraniem kolejnych porcji danych (tak aby dotrzeć do danych najświeższych), należy w parametrze journal-start przekazywać wartość deal-event-id ostatniego (setnego) elementu, zwracanego w ramach danego wywołania i robić to sukcesywnie, dopóki w wyniku wywołania nie otrzyma się porcji danych mniejszej niż 100 elementów (co będzie świadczyło, że otrzymane dane są danymi najświeższymi).

  1. session-id | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. journal-start | long | niewymagany
    Punkt startu, pozwalający na sterowanie pobieraniem kolejnych porcji danych dot. informacji o zdarzeniach związanych z formularzami pozakupowymi (jego wartość zwracana jest w polu deal-event-id struktury site-journal-deals).



Orientacyjna struktura wywołania metody

$dogetsitejournaldeals_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'journal-start' => 4556899786
);

  1. site-journal-deals | SiteJournalDealsStruct[]
    Tablica struktur zawierających informacje o zdarzeniach związanych z formularzami zakupowymi.
    1. deal-event-id | long
      Identyfikator zdarzenia.
    2. deal-event-type | int
      Typ zdarzenia (1 - utworzenie aktu zakupowego (deala), 2 - utworzenie formularza pozakupowego (transakcji), 3 - anulowanie formularza pozakupowego (transakcji), 4 - zakończenie (opłacenie) transakcji przez PzA). Każde z typów zdarzeń (oprócz 1, dla którego ID transakcji nie jest jeszcze znane), generowane jest osobno dla każdego deala wchodzącego w skład transakcji.
    3. deal-event-time | long
      Data zapisania zdarzenia w dzienniku (w formacie Unix time).
    4. deal-id | long
      Identyfikator aktu zakupowego (do pobrania za pomocą metody doGetDeals).
    5. deal-transaction-id | long
      Identyfikator transakcji (do pobrania za pomocą metody doGetTransactionsIDs).
    6. deal-seller-id | int
      Identyfikator sprzedającego.
    7. deal-item-id | long
      Identyfikator oferty.
    8. deal-buyer-id | int
      Identyfikator kupującego.
    9. deal-quantity | int
      Informacja o liczbie kupionych przedmiotów w danym akcie zakupowym.



Orientacyjna struktura odpowiedzi serwera

$dogetsitejournaldeals_response = array(
   'site-journal-deals' => array(
      array(
         'deal-event-id' => 4556899786,
         'deal-event-type' => 1,
         'deal-event-time' => 1310432400,
         'deal-id' => 1269603383,
         'deal-transaction-id' => 0,
         'deal-seller-id' => 4109848,
         'deal-item-id' => 1635208744,
         'deal-buyer-id' => 3301720,
         'deal-quantity' => 2),
      array(
         'deal-event-id' => 4556899787,
         'deal-event-type' => 2,
         'deal-event-time' => 1310432500,
         'deal-id' => 1269603383,
         'deal-transaction-id' => 65058640,
         'deal-seller-id' => 4109848,
         'deal-item-id' => 1635208744,
         'deal-buyer-id' => 3301720,
         'deal-quantity' => 2),
      array(
         'deal-event-id' => 4556969996,
         'deal-event-type' => 3,
         'deal-event-time' => 1311733650,
         'deal-id' => 1269603383,
         'deal-transaction-id' => 65058640,
         'deal-seller-id' => 4109848,
         'deal-item-id' => 1635208744,
         'deal-buyer-id' => 3301720,
         'deal-quantity' => 2))
);

  • ERR_INCORRECT_JOURNAL_START
    Niepoprawna wartość dla punktu startu.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI na którym została wygenerowana sesja został zdezaktywowany (jego właściciel nie zaakceptował warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.

Allegro nie bierze odpowiedzialności za skutki wykorzystania zamieszczonych przykładów kodu, nie daje także gwarancji ich poprawnego działania. Widoczny kod ma charakter wyłącznie poglądowy i może zawierać błędy.