Allegro WebAPI

Interfejs programistyczny platformy Allegro

doMyAccount2

Tematyka: Moje Allegro
Ostatnia zmiana: 14.02.2012 r.
Dostępność:

Metoda pozwala na pobranie listy ofert z poszczególnych zakładek Mojego Allegro (licytowane, kupione, niekupione, sprzedawane, sprzedane, niesprzedane, do wystawienia) zalogowanego użytkownika. Domyślnie zwracanych jest pierwszych 25 ofert z danej zakładki, posortowanych malejąco po czasie ich zakończenia. Możesz także pobrać informacje o konkretnych ofertach z danej zakładki (itemsArray). Pełen podgląd nazw oraz identyfikatorów kupujących możliwy jest tylko dla zakładek typu 'sell' i 'sold' - dla pozostałych typów wspomniane dane zwrócone zostaną w formie zanonimizowanej.

Ważne! Po ręcznym usunięciu ofert z zakładek Mojego Allegro na WWW, metoda również przestanie zwracać informacje o nich.


  1. session-handle |  string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. account-type | string | wymagany
    Wybrany typ zakładki Mojego Allegro (bid - oferty z zakładki Licytuję, won - oferty z zakładki Kupione, not_won - oferty z zakładki Niekupione, sell - oferty z zakładki Sprzedaję, sold - oferty z zakładki Sprzedane, not_sold - aoferty z zakładki Niesprzedane, future - oferty z zakładki Do wystawienia). Od 20.10.2016 (data wdrożenia nowej wersji Obserwowanych) parametry watch i watch_cl nie zwracają danych.
  3. offset |  int | niewymagany
    Parametr pozwalający na sterowanie miejscem rozpoczęcia pobierania listy ofert. Wartość parametru wskazuje na to, od której oferty z kolei (biorąc pod uwagę sposób sortowania listy - rosnąco po czasie zakończenia), ma zostać pobrana paczka 25 ofert (oferty indeksowane są od 0).
  4. items-array | long[] | niewymagany
    Tablica identyfikatorów ofert.
  5. limit | int | niewymagany
    Parametr pozwalający na określenie rozmiaru porcji danych (minimum: 1, maksimum: 100, domyślnie: 25).



Orientacyjna struktura wywołania metody

$domyaccount2_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'account-type' => 'won',
   'offset' => 0,
   'items-array' => array(),
   'limit' => 1
);

  1. myaccount-list | MyAccountStruct2[]
    Tablica struktur zawierających informacje o ofertach wybranego typu.
    1. my-account-array | string[]
      Tablica, w której zwracane są wszystkie publicznie dostępne informacje nt. ofert. Kolejne jej pola zawierają:
      • identyfikator oferty,
      • cena wywoławcza przedmiotu (lub 0.00 gdy nie została ustawiona),
      • obecna cena przedmiotu,
      • cena minimalna przedmiotu (lub 0.00 gdy nie została ustawiona),
      • cena Kup Teraz! (lub 0.00 gdy nie została ustawiona),
      • początkowa liczba przedmiotów dostępnych w ofercie,
      • czas rozpoczęcia oferty (w czasie jej trwania, widzi ją tylko sprzedający),
      • czas zakończenia oferty,
      • identyfikator kupującego oferującego najwyższą cenę (lub 0 gdy nikt jeszcze nie złożył oferty),
      • tytuł oferty,
      • liczba złożonych ofert kupna,
      • identyfikator sprzedającego,
      • identyfikator kraju,
      • wartość informująca o wybranych dla oferty opcjach dodatkowych (więcej),
      • maksymalna cena oferowana za przedmiot przez użytkownika,
      • maksymalna cena oferowana za przedmiot,
      • liczba przedmiotów, które do tej pory nie zostały sprzedane, ale jeszcze mogą zostać sprzedane (dot. ofert trwających),
      • liczba przedmiotów, które zostały do tej pory sprzedane (dot. ofert trwających),
      • pole zdezaktualizowane (zawsze będzie zwracać NULL),
      • liczba sprzedanych przedmiotów (dot. ofert zakończonych),
      • liczba niesprzedanych przedmiotów (dot. ofert zakończonych),
      • nazwa kupującego (lub 0 w przypadku braku ofert, pełna wartość pola widoczna jest tylko dla sprzedającego w danej ofercie, dla pozostałych w polu zwracana jest nazwa użytkownika w formie zanonimizowanej: X...Y),
      • null,
      • kraj kupującego (lub 0 w przypadku braku ofert),
      • nazwa sprzedającego,
      • null,
      • kraj sprzedającego,
      • liczba osób obserwujących aukcję (lub NULL w przypadku braku obserwujących),
      • informacja o tym, czy w ofercie włączona  jest opcja Kup Teraz! (1 - jest, 0 - nie jest),
      • liczba zdjęć dołączonych do oferty,
      • treść notatki dodanej przez sprzedającego do oferty (widoczna tylko dla sprzedającego, dla pozostałych oraz w przypadku braku notatki zwracane jest 0),
      • informacja o tym, na ile minut przed końcem oferty ma zostać wysłane e-mailem przypomnienie o tym fakcie (dot. ofert obserwowanych),
      • tekstowy status oferty oczekującej na wystawienie (np. 'Oczekuje', 'Wstrzymana przez administratora Allegro', itp.),
      • liczba wyświetleń oferty,
      • pole zdezaktualizowane (zawsze będzie zwracać NULL),
      • pole zdezaktualizowane (zawsze będzie zwracać NULL),
      • informacja o tym, czy oferta jest powiązana z produktem (1 - jest, 0 - nie jest, dotyczy typów: sell, sold, not_sold, future),
      • informacja o tym, czy oferta jest oznaczona jako Standard Allegro [PL]/Aukro Plus [CZ]/Super Offer [UA/KZ] (1 - jest, 0 - nie jest, dotyczy typów: won, not_won, watch, watch_cl, sell, sold, not_sold).



Orientacyjna struktura odpowiedzi serwera

$domyaccount2_response = array(
   'myaccount-list' => array(
      'my-account-array' => array(
         '946564965',
         'NULL',
         '16.50',
         'NULL',
         '16.50',
         '8',
         'NULL',
         '2010-03-25 14:03:45',
         'NULL',
         'Kombajn do zbierania kur po wioskach Ósme piętro',
         'NULL',
         '7730428',
         '1',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         '1',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         'Fonografika-pl',
         '4906',
         '1',
         'NULL',
         'NULL',
         '1',
         '0',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         'NULL',
         '1'))
);

  • ERR_NO_DATABASE
    Problemy z bazą danych Allegro.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_TOO_HIGH_LIMIT_VALUE
    Wartość rozmiaru porcji danych poza zakresem (dopuszczalny zakres: 1-100).
  • 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.