Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetPostBuyData

Ostatnia zmiana: 27.07.2015 r.
Dostępność:
Metoda pozwala na pobranie pełnych danych kontaktowych kontrahentów z danej oferty. Metoda zwraca różne dane - w zależności od tego, czy zalogowany użytkownik był sprzedającym (user-data, user-sent-to-data), czy kupującym (user-data, user-bank-accounts, company-second-address) w ramach danej oferty. W przypadku podania niepoprawnego identyfikatora oferty, zostanie dla niego zwrócona pusta struktura. Metoda nie zwraca danych dotyczących ofert przeniesionych do archiwum.

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. items-array | long[] | wymagany
    Tablica identyfikatorów ofert (maks. 25).
  3. buyer-filter-array | long[] | niewymagany
    Tablica identyfikatorów użytkowników (maks. 25).



Orientacyjna struktura wywołania metody

$dogetpostbuydata_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'items-array' => array(972090662, 959671296, 863180420),
   'buyer-filter-array' => array(429573)
);

  1. items-post-buy-data | ItemPostBuyDataStruct[]
    Tablica struktur zawierających informacje o ofertach oraz dane kontrahentów.
    1. item-id | long
      Identyfikator oferty.
    2. users-post-buy-data | UserPostBuyDataStruct[]
      Tablica struktur zawierająca dane kontrahenta pozwalające sfinalizować transakcję.
      1. user-data | UserDataStruct
        Struktura zawierająca dane kontaktowe kontrahenta dla wskazanej oferty (dot. zarówno kupujących, jak i sprzedających).
        1. user-id | long
          Identyfikator użytkownika.
        2. user-login | string
          Nazwa użytkownika.
        3. user-rating | int
          Liczba punktów użytkownika.
        4. user-first-name | string
          Imię użytkownika.
        5. user-last-name | string
          Nazwisko użytkownika.
        6. user-maiden-name | string
          Nazwisko panieńskie matki użytkownika (nie jest pokazywane żadnej ze stron).
        7. user-company | string
          Nazwa firmy użytkownika.
        8. user-country-id | int
          Identyfikator kraju użytkownika.
        9. user-state-id | int
          Identyfikator regionu (województwa) użytkownika (dla użytkowników niezarejestrowanych, w polu zawsze zwracane jest 0).
        10. user-postcode | string
          Kod pocztowy użytkownika.
        11. user-city | string
          Miasto użytkownika.
        12. user-address | string
          Adres użytkownika.
        13. user-email | string
          E-mail użytkownika.
        14. user-phone | string
          Telefon użytkownika.
        15. user-phone2 | string
          Drugi telefon użytkownika.
        16. user-ss-status | int
          Informacja o przynależności użytkownika do programu Super Sprzedawca (1 - użytkownik jest Super Sprzedawcą, 0 - użytkownik nie jest Super Sprzedawcą).
        17. site-country-id | int
          Identyfikator kraju (serwisu), w którym użytkownik rejestrował konto.
        18. user-junior-status | int
          Informacja o tym, czy konto zostało zarejestrowane jako Junior (1 - tak, 0 - nie).
        19. user-birth-date | long
          Data urodzenia użytkownika (nie jest pokazywana żadnej ze stron).
        20. user-has-shop | int
          Informacja o tym, czy na koncie użytkownika jest aktywny Sklep Allegro (1 - jest, 0 - nie jest).
        21. user-company-icon | int
          Informacja o tym, czy konto zostało zarejestrowane jako Firma (1 - tak, 0 - niedla UA/KZ zawsze zwracane będzie 0).
      2. user-sent-to-data | UserSentToDataStruct
        Struktura zawierająca dane adresowe do wysyłki (wypełniona struktura zwracana jest tylko wtedy, gdy kupujący uzupełnił dane adresowe do wysyłki, a użytkownik wywołujący metodę był sprzedającym w ramach danej oferty).
        1. user-id | long
          Identyfikator użytkownika.
        2. user-first-name | string
          Imię użytkownika.
        3. user-last-name | string
          Nazwisko użytkownika.
        4. user-company | string
          Nazwa firmy użytkownika.
        5. user-country-id | int
          Identyfikator kraju użytkownika.
        6. user-postcode | string
          Kod pocztowy użytkownika.
        7. user-city | string
          Miasto użytkownika.
        8. user-address | string
          Adres użytkownika.
      3. user-bank-accounts | string[]
        Tablica zawierająca numery kont użytkownika (wypełniona tablica zwracana jest tylko wtedy, gdy sprzedający podał numery kont, a użytkownik wywołujący metodę był kupującym w ramach danej oferty).
      4. company-second-address | CompanySecondAddressStruct
        Struktura zawierająca informacje o pracowniku obsługującym konto oraz adresie firmy (dot. tylko użytkowników z kontem zarejestrowanym jako Firma).
        1. company-worker-first-name | string
          Imię osoby obsługującej konto.
        2. company-worker-last-name | string
          Nazwisko osoby obsługującej konto.
        3. company-address | string
          Adres siedziby firmy.
        4. company-postcode | string
          Kod pocztowy.
        5. company-city | string
          Miasto, w którym znajduje się siedziba firmy.
        6. company-country-id | int
          Identyfikator kraju, w którym znajduje się siedziba firmy.
        7. company-state-id | int
          Identyfikator województwa, w którym znajduje się siedziba firmy.



Orientacyjna struktura odpowiedzi serwera

$dogetpostbuydata_response = array(
   'items-post-buy-data' => array(
      array(
         'item-id' => 972090662,   // dane kupującego (dla sprzedającego)
         'user-post-buy-data' => array(
            array(
               'user-data' => array(
                  'user-id' => 1235813,
                  'user-login' => 'janek123',
                  'user-rating' => 205,
                  'user-first-name' => 'Jan',
                  'user-last-name' => 'Nowak',
                  'user-maiden-name' => '',
                  'user-company' => 'Grupa Allegro Sp. z o. o.',
                  'user-country-id' => 1,
                  'user-state-id' => 15,
                  'user-postcode' => '60-324',
                  'user-city' => 'Poznań',
                  'user-address' => 'ul. Marcelińska 90',
                  'user-email' => 'jan.nowak@email.pl',
                  'user-phone' => '987-654-321',
                  'user-phone2' => '',
                  'user-ss-status' => 0,
                  'site-country-id' => 1,
                  'user-junior-status' => 0,
                  'user-birth-date' => 0,
                  'user-has-shop' => 0,
                  'user-company-icon' => 0),
               'user-sent-to-data' => array(
                  'user-id' =>
1235813,
                  'user-first-name' => 'Jan',
                  'user-last-name' => 'Nowak',
                  'user-company' => '',
                  'user-country-id' => 1,
                  'user-postcode' => '60-328',
                  'user-city' => ‘Poznań',
                  'user-address' => 'ul. Wspólna 80'),
               'user-bank-accounts' => array(),
               'company-second-address' => array(
                  'company-worker-first-name' => '',
                  'company-worker-last-name' => '',
                  'company-address' => '',
                  'company-postcode' => '',
                  'company-city' => '',
                  'company-country-id' => 0,
                  'company-state-id' => 0)))),
      array(
         'item-id' => 959671296,   // dane sprzedającego (dla kupującego)
         'user-post-buy-data' => array(
            array(
               'user-data' => array(
                  'user-id' => 24610129,
                  'user-login' => 'piotrek321',
                  'user-rating' => 306,
                  'user-first-name' => 'Piotr',
                  'user-last-name' => 'Kowalski',
                  'user-maiden-name' => '',
                  'user-company' => '',
                  'user-country-id' => 1,
                  'user-state-id' => 2,
                  'user-postcode' => '12-345',
                  'user-city' => 'Warszawa',
                  'user-address' => 'ul. Kolejowa 89',
                  'user-email' => 'piotr.kowalski@email.pl',
                  'user-phone' => '111-222-333',
                  'user-phone2' => '(22)7123-456',
                  'user-ss-status' => 0,
                  'site-country-id' => 1,
                  'user-junior-status' => 0,
                  'user-birth-date' => 0,
                  'user-has-shop' => 1,
                  'user-company-icon' => 1),
               'user-sent-to-data' => array(
                  ' user-id' => 0,
                  ' user-first-name' => '',
                  ' user-last-name' => '',
                  ' user-company' => '',
                  ' user-country-id' => 0,
                  ' user-postcode' => '',
                  ' user-city' => '',
                  ' user-address' => ''),
               ' user-bank-accounts' => array(481122334455667788990011223344),
               ' company-second-address' => array(
                  ' company-worker-first-name' => 'Piotr',
                  ' company-worker-last-name' => 'Kowalski',
                  ' company-address' => '',
                  ' company-postcode' => '',
                  'company-city' => '',
                  'company-country-id' => 0,
                  'company-state-id' => 0)))),
      array(
         'item-id' => 863180420,   // niepoprawny identyfikator oferty
         'user-post-buy-data' => array()))
);


  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_USERS_ARRAY_OVERSIZED
    Liczba podanych identyfikatorów użytkowników przekracza dopuszczalny limit (maks. 25)
  • ERR_WEBAPI_EXPIRED
    Data ważności klucza WebAPI została przekroczona.
  • ERR_WEBAPI_KEY
    Niepoprawna wartość klucza WebAPI lub klucz został zablokowany.
  • 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.

#1 (25.04.2010 r.) / php (Autor: danielnowacki)
  1. /**
  2. * Definicja metod klienta do komunikacji z usługami WebAPI
  3. *
  4. * @package Allegro/Client
  5. * @author Daniel Nowacki http://nowacki.org.pl
  6. * @version 1.0
  7. */
  8. abstract class Allegro_Client_Abstract extends SoapClient
  9. {
  10. ...
  11.  
  12. /**
  13. * Pobiera dane kontaktowe uczestników aukcji
  14. *
  15. * @see http://webapi.allegro.pl/uploader.php?apiMethod=doGetPostBuyData
  16. *
  17. * @param array $auctionList tablica z numerami aukcji
  18. * @return array dane kontaktowe uczestników
  19. */
  20. public function &getPostBuyData($auctionList)
  21. {
  22. $list = is_array($auctionList) ? $auctionList : array($auctionList);
  23.  
  24. $arrayList = array_chunk($list, 25); // dziele tablice na porcje po 25 - maksymalna paczka danych przyjmowana przez WebAPI
  25.  
  26. $users = array();
  27. foreach($arrayList as $portion)
  28. {
  29. $users = array_merge($users, $this->doGetPostBuyData($this->getSessionHandle()->getIdentifier(), $portion));
  30. }
  31.  
  32. return $users;
  33. }
  34.  
  35. ...
  36. }