Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetItemsInfo

Ostatnia zmiana: 27.11.2014 r.
Dostępność:
Metoda pozwala na pobranie wszystkich dostępnych informacji (m.in. opis, kategoria, zdjęcia, parametry, dostępne sposoby dostawy i formy płatności, etc.) o wskazanych ofertach.

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. items-id-array | long[] | wymagany
    Tablica identyfikatorów ofert, o których mają być pobrane informacje (maks. 25).
  3. get-desc | int | niewymagany
    Parametr wskazujący na to, czy ma zostać pobrany opis oferty (1 - tak, 0 - nie; domyślna wartość: 0).
  4. get-image-url | int | niewymagany
    Parametr wskazujący na to, czy mają zostać pobrane odnośniki do zdjęć (1 - tak, 0 - nie; domyślna wartość: 0).
  5. get-attribs | int | niewymagany
    Parametr wskazujący na to, czy ma zostać pobrana lista parametrów przypisanych do oferty (1 - tak, 0 - nie; domyślna wartość: 0).
  6. get-postage-options | int | niewymagany
    Parametr wskazujący na to, czy mają zostać pobrane opcje dostawy wybrane dla oferty (1 - tak, 0 - nie; domyślna wartość: 0).
  7. get-company-info | int | niewymagany
    Parametr wskazujący na to, czy mają zostać pobrane dane (dotyczy tylko ofert wystawionych na koncie zarejestrowanym jako Firma) wystawiającego ofertę (1 - tak, 0 - nie; domyślna wartość: 0).
  8. get-product-info | int | niewymagany
    Parametr zdezaktualizowany.
  9. getAfterSalesServiceConditions | int | niewymagany
    Parametr wskazujący na to, czy mają zostać pobrane dane o warunkach oferty (1 - tak, 0 - nie; domyślna wartość: 0).
  10. getEan | int | niewymagany
    Parametr wskazujący na to, czy mają zostać pobrane dane o warunkach oferty (1 - tak, 0 - nie; domyślna wartość: 0).



Orientacyjna struktura wywołania metody

$dogetitemsinfo_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'items-id-array' => array(975967833, 886978949),
   'get-desc' => 1,
   'get-image-url' => 1,
   'get-attribs' => 1,
   'get-postage-options' => 1,
   'get-company-info' => 0,
   'get-product-info' => 0,
   'getAfterSalesServiceConditions' => 0

);

  1. array-item-list-info | ItemInfoStruct[]
    Tablica struktur zawierających informacje o wskazanych ofertach.
    1. item-info | ItemInfo
      Struktura zawierająca ogólne informacje o ofercie.
      1. it-id | long
        Identyfikator oferty.
      2. it-country | int
        Identyfikator kraju, w którym wystawiona została oferta.
      3. it-name | string
        Tytuł oferty.
      4. it-price | float
        Aktualna cena (dla ofert typu aukcja z licytacją).
      5. it-bid-count | int
        Liczba ofert kupna złożonych w ofercie.
      6. it-ending-time | long
        Czas zakończenia oferty (w formacie Unix time).
      7. it-seller-id | long
        Identyfikator sprzedającego.
      8. it-seller-login | string
        Nazwa sprzedającego.
      9. it-seller-rating | int
        Liczba punktów sprzedającego.
      10. it-starting-time | long
        Czas rozpoczęcia oferty (w formacie Unix time; widoczny tylko dla użytkownika, który daną ofertę wystawiał - dla pozostałych w polu zwracane jest 0).
      11. it-starting-price | float
        Cena wywoławcza (dla ofert typu aukcja z licytacją; widoczna tylko dla użytkownika, który daną ofertę wystawiał - dla pozostałych w polu zwracane jest 0).
      12. it-quantity | int
        Aktualna liczba przedmiotów dostępnych w ofercie.
      13. it-foto-count | int
        Liczba zdjęć dołączonych do oferty (dotyczy tylko tych wgranych na serwery Allegro).
      14. it-reserve-price | float
        Cena minimalna (dla ofert typu aukcja z licytacją; widoczna tylko dla użytkownika, który daną ofertę wystawiał, dla pozostałych w polu zwracane jest: 0 - jeżeli cena minimalna nie jest ustawiona, -1 - jeżeli aktualna cena jest niższa od ceny minimalnej, -2 - jeżeli aktualna cena jest równa lub wyższa od ceny minimalnej).
      15. it-location | string
        Lokalizacja przedmiotu.
      16. it-buy-now-price | float
        Cena Kup Teraz! (jeżeli cena KT! nie jest ustawiona w ofercie, w polu zwracane jest 0).
      17. it-buy-now-active | int
        Informacja o tym, czy w ofercie jest ustawiona (i cały czas aktywna) cena Kup Teraz! (1 - jest, 0 - nie jest).
      18. it-high-bidder | int
        Identyfikator użytkownika, który złożył najwyższą ofertę kupna.
      19. it-high-bidder-login | string
        Nazwa użytkownika, który złożył najwyższą ofertę kupna.
      20. it-description | string
        Opis oferty.
      21. itStandardizedDescription | string
        Nowy opis oferty.
      22. it-options | int
        Wartość informująca o wybranych dla oferty opcjach dodatkowych (więcej).
      23. it-state | int
        Identyfikator regionu (województwa).
      24. it-is-eco | int
        Informacja o tym, czy oferta jest promowana na liście ofert Eko-Użytkowników (1 - jest, 0 - nie jest).
      25. it-hit-count | long
        Liczba wyświetleń oferty.
      26. it-postcode | string
        Kod pocztowy (jeżeli sprzedający zdecydował się na udostępnianie go w opisie).
      27. it-vat-invoice | int
        Informacja o tym, czy sprzedający wystawia faktury VAT (1 - wystawia, 0 - nie wystawia).
      28. it-bank-account1 | string
        Pierwszy numer konta bankowego sprzedającego.
      29. it-bank-account2 | string
        Drugi numer konta bankowego sprzedającego.
      30. it-starting-quantity | int
        Początkowa liczba przedmiotów dostępnych w ofercie.
      31. it-is-for-guests | int
        Informacja o tym, czy zakupu mogą dokonać użytkownicy bez rejestracji (1 - mogą, 0 - nie mogą).
      32. it-has-product | int
        Informacja o tym, czy oferta jest powiązana z produktem (1 - jest, 0 - nie jest).
      33. it-order-fulfillment-time | int
        Informacja o najkrótszym dostępnym czasie realizacji zamówienia (w godzinach). W UA działa jako "Wysyłka w ciagu" wraz z dodatkową wartością 1 ('natychmiast').
      34. it-ending-info | int
        Informacja na temat stanu oferty (1 - trwa, 2 - zakończyła się w sposób "naturalny" (koniec czasu trwania, albo wykupienie wszystkich dostępnych przedmiotów w przypadku Kup Teraz), 3 - została zakończona przez sprzedającego przed czasem).
      35. it-is-allegro-standard | int
        Informacja o tym, czy oferta jest oznaczona jako Standard Allegro [PL], Aukro Plus [CZ] lub Super Offer [UA/KZ] (1 - jest, 0 - nie jest).
      36. it-is-new-used | int
        Informacja o stanie przedmiotu (0 - stan przedmiotu nie został ustalony, 1 - przedmiot jest nowy, 2 - przedmiot jest używany).
      37. it-is-brand-zone | int
        Informacja o tym, czy oferta została wystawiona w ramach Strefy Marek (1 - jest, 0 - nie jest).
      38. it-duration-info | DurationInfoStruct[]
        Struktura zawierająca informacje o czasie trwania oferty.
        1. duration-type | int
          Informacja o typie czasu trwania oferty (1 - oferta z zaplanowanym czasem zakończenia, 2 - oferta trwająca do wyczerpania przedmiotów).
    2. item-cats | ItemCatList[]
      Tablica struktur zawierających informacje o strukturze kategorii oferty.
      1. cat-level | int
        Identyfikator poziomu zagłębienia kategorii (indeksowany od 0).
      2. cat-id | long
        Identyfikator kategorii.
      3. cat-name | string
        Nazwa kategorii.
    3. item-images | ItemImageList[]
      Tablica struktur zawierających informacje o zdjęciach dodanych do oferty.
      1. image-type | int
        Typ zdjęcia (1 - miniaturka, 2 - średni rozmiar, 3 - oryginalne zdjęcie).
      2. image-url | string
        Odnośnik do zdjęcia.
    4. item-attribs | AttribStruct[]
      Tablica struktur zawierających informacje o parametrach ustawionych dla oferty.
      1. attrib-name | string
        Nazwa parametru.
      2. attrib-values | string[]
        Tablica wartości parametru (parametry typu zakresowego zwracane są pod postacią dwóch osobnych elementów tablicy: array[0] = wartość_początkowa; array[1] = wartość_końcowa).
    5. item-postage-options | PostageStruct[]
      Tablica struktur zawierających informacje o opcjach dostawy wybranych dla oferty.
      1. postage-amount | float
        Cena za pierwszą sztukę.
      2. postage-amount-add | float
        Cena za kolejne sztuki (w przypadku niezdefiniowania przez sprzedającego, domyślnie przyjmowana jest tu wartość równa postage-amount).
      3. postage-pack-size | int
        Liczba w paczce (w przypadku niezdefiniowania przez sprzedającego, domyślnie przyjmowana jest tu wartość 1).
      4. postage-id | int
        Identyfikator sposobu dostawy (listę identyfikatorów sposobów dostawy uzyskać można za pomocą metody doGetShipmentData).
      5. postage-free-shipping | int
        Informacja o tym, czy dla danej opcji dostawy sprzedający ustalił wysyłkę gratis (1 - tak, 0 - nie).
      6. postage-fulfillment-time | FulfillmentTimeStruct
        Struktura zawierająca informacje (w godzinach) o przybliżonym 'Czasie realizacji zamówienia' dla danej oferty.
        1. fulfillment-time-from | int
          Początek zakresu (w godzinach) dla przybliżonego 'Czasu realizacji zamówienia' (informacja zwracana tylko dla PL). 0 w polu oznacza, że sprzedający nie określił czasu dla 'Wysyłki w ciągu' lub 'Czas realizacji zamówienia' nie jest w danym kraju obsługiwany.
        2. fulfillment-time-to | int
          Koniec zakresu (w godzinach) dla przybliżonego 'Czasu realizacji zamówienia' (informacja zwracana tylko dla PL). 0 w polu oznacza, że sprzedający nie określił czasu dla 'Wysyłki w ciągu' lub 'Czas realizacji zamówienia' nie jest w danym kraju obsługiwany.
    6. item-payment-options | ItemPaymentOptions
      Struktura zawierająca informacje o formach płatności wybranych dla oferty.
      1. pay-option-transfer | int
        Zwykły przelew (1 - opcja włączona, 0 - opcja wyłączona).
      2. pay-option-on-delivery | int
        Płatność przy odbiorze (1 - opcja włączona, 0 - opcja wyłączona)
      3. pay-option-allegro-pay | int
        PayU (1 - opcja włączona, 0 - opcja wyłączona).
      4. pay-option-see-desc | int
        Dodatkowe informacje o przesyłce i płatności (1 - opcja włączona, 0 - opcja wyłączona).
      5. pay-option-payu | int
        Pole zdezaktualizowane (zawsze będzie zwracać 0).
      6. pay-option-escrow | int
        Pole zdezaktualizowane (zawsze będzie zwracać 0).
    7. item-company-info | CompanyInfoStruct
      Struktura zawierająca podstawowe informacje na temat firmy (jeżeli oferta została wystawiona z konta zarejestrowanego jako Firma).
      1. company-first-name | string
        Imię osoby obsługującej konto.
      2. company-last-name | string
        Nazwisko osoby obsługującej konto.
      3. company-name | string
        Nazwa firmy.
      4. company-address | string
        Adres siedziby firmy.
      5. company-postcode | string
        Kod pocztowy.
      6. company-city | string
        Miasto, w którym znajduje się siedziba firmy.
      7. company-nip | string
        NIP firmy.
    8. item-product-info | ProductStruct
      Struktura zdezaktualizowana.
      1. product-id | long
        Pole zdezaktualizowane (zawsze będzie zwracać 0).
      2. product-name | string
        Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
      3. product-description | string
        Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
      4. product-images-list | string[]
        Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
      5. product-parameters-group-list | ProductParametersGroupStruct[]
        Struktura zdezaktualizowana.
        1. product-parameters-group-name | string
          Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
        2. product-parameters-list | ProductParametersStruct[]
          Struktura zdezaktualizowana.
          1. product-parameter-name | string
            Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
          2. product-parameter-values | string[]
            Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
          3. product-parameter-description | string
            Pole zdezaktualizowane (zawsze będzie zwracać pustą wartość).
    9. AfterSalesServiceConditions | AfterSalesServiceConditionsStruct 
      Struktura zawiera informacje jakie warunki są przypisane w ofercie.
      1. impliedWarranty | string
        Identyfikator (uuid) warunków reklamacji. Możesz go pobrać przez zasób GET /afterSalesServiceConditions/implied-warranties w REST API.
      2. returnPolicy | string
        Identyfikator (uuid) polityki zwrotów. Możesz go pobrać przez zasób GET /afterSalesServiceConditions/return-policies w REST API.
      3. warranty | string
        Identyfikator (uuid) Informacji o gwarancjach. Możesz go pobrać przez zasób GET /afterSalesServiceConditions/warranties w REST API.
    10. itEan | int 
      Kod EAN zdefiniowany dla danej oferty
  2. array-items-not-found | long[]
    Tablica identyfikatorów ofert, o których nie pobrano informacji z uwagi na fakt, że dana oferta została przeniesiona do archiwum (zakończyła się później niż 60 dni temu) lub podano błędny identyfikator oferty.
  3. array-items-admin-killed | long[]
    Tablica identyfikatorów ofert, do których nie pobrano informacji z uwagi na fakt, że dana oferta została usunięta przez administratora serwisu.



Orientacyjna struktura odpowiedzi serwera

$dogetitemsinfo_response = array(
   'array-item-list-info' => array(
      'item-info' => array(
         'it-id' => 975967833,
         'it-country' => 1,
         'it-name' => 'Oferta testowa',
         'it-price' => 0.00,
         'it-bid-count' => 0,
         'it-ending-time' => 1270204577,
         'it-seller-id' => 4109848,
         'it-seller-login' => 'm010ch',
         'it-seller-rating' => 228,
         'it-starting-time' => 1269603377,
         'it-starting-price' => 0.00,
         'it-quantity' => 1,
         'it-foto-count' => 1,
         'it-reserve-price' => 0.00,
         'it-location' => 'Poznań',
         'it-buy-now-price' => 1.00,
         'it-buy-now-active' => 1,
         'it-high-bidder' => 0,
         'it-high-bidder-login' => '',
         'it-description' => 'Opis testowej oferty.',
         'it-options' => 67108896,
         'it-state' => 15,
         'it-is-eco' => 0,
         'it-hit-count' => 5,
         'it-postcode' => '',
         'it-vat-invoice' => 0,
         'it-bank-account1' => '',
         'it-bank-account2' => '',
         'it-starting-quantity' => 2,
         'it-is-for-guests' => 1,
         'it-has-product' => 1,
         'it-order-fulfillment-time' => 48,
         'it-ending-info' => 2,
         'it-is-allegro-standard' => 1,
         'it-is-new-used' => 1,
         'it-is-brand-zone' => 0,
         'it-duration-info' => array(,
             'duration-type' => 1)),
      'item-cats' => array(
         array(
            'cat-level' => 0,
            'cat-id' => 73973,
            'cat-name' => 'Delikatesy'),
         array(
            'cat-level' => 1,
            'cat-id' => 73975,
            'cat-name' => 'Makarony')),
      'item-images' => array(
         array(
            'image-type' => 1,
            'image-url' => 'http://img16.allegroimg.pl/photos/128x96/975/96/78/975967833'),
         array(
            'image-type' => 2,
            'image-url' => 'http://img16.allegroimg.pl/photos/400x300/975/96/78/975967833'),
         array(
            'image-type' => 3,
            ' image-url' => 'http://img16.allegroimg.pl/photos/oryginal/975/96/78/975967833')),
      'item-attribs' => array(
         array(
            ' attrib-name' => 'Kształt',
            ' attrib-values' => array('świderki')),
         array(
            'attrib-name' => 'Skład',
            'attrib-values' => array('bezjajeczny'))),
      'item-postage-options' => array(
         array(

            'postage-amount' => 0.00,
            'postage-amount-add' => 0.00,
            'postage-pack-size' => 1,
            'postage-id' => 12,
            'postage-free-shipping' => 0,

            'postage-fulfillment-time' => array(
               'fulfillment-time-from' => 24,
               'fulfillment-time-to' => 24))),
      'item-payment-options' => array(
         'pay-option-transfer' => 0,
         'pay-option-on-delivery' => 0,
         'pay-option-allegro-pay' => 1,
         'pay-option-see-desc' => 0,
         'pay-option-payu' => 0,
         'pay-option-escrow' => 0),
      'item-company-info' => array(
         'company-first-name' => '',
         'company-last-name' => '',
         'company-name' => '',
         'company-address' => '',
         'company-postcode' => '',
         'company-city' => '',
         'company-nip' => '') ,
      'item-product-info' => array(
         'product-id' => 0,
         'product-name' => '',
         'product-description' => '',
         'product-images-list' => array(),
         'product-parameters-group-list' => array(
            array(
               'product-parameters-group-name' => '',  
               'product-parameters-list' => array(
                  array(
                     'product-parameter-name' => '',
                     'product-parameter-value' => array(),
                     'product-parameter-description' => ''))),
   'array-items-not-found' => array(886978949),
   'array-items-admin-killed' => array()
);


  • ERR_ITEMS_ARRAY_OVERSIZED
    Nie podano żadnego identyfikatora oferty lub liczba podanych identyfikatorów przekracza dopuszczalny limit (maks. 25).
  • 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.

#1 (18.12.2010 r.) / php (Autor: Kshysioo)
  1. <?php
  2.  
  3. // Zakladajac, ze wykorzystano moj przyklad z doGetUserItems mamy wszystkie aktywne aukcje w tablicy
  4. // mozemy w prosty sposob pobrac opisy dla nich - pamietajac o limicie nakladanym przez API:
  5.  
  6. if ( $items['user-item-count'] > 0 )
  7. {
  8. echo 'Znaleziono '.$items ['user-item-count'].' aukcji'."n";
  9.  
  10. foreach ( $items['user-item-list'] as $item )
  11. {
  12. $toGet[] = $item -> {'it-id'};
  13. }
  14.  
  15. foreach ( array_chunk ( $toGet, 25 ) as $chunk )
  16. {
  17. $descs[] = $client -> doGetItemsInfo ( $session['session-handle-part'], $chunk, 1, 1 );
  18. }
  19. }
  20.  
  21. // Dlaczego najpierw iterowalem po tablicy aukcji, a pozniej dopiero odpytuje API? Otoz nalezy pamietac, aby dbac
  22. // o ilosc requestow http przesylanych do zewnetrznych uslug. Dlatego najpierw zbudowalismy tablice ID aukcji
  23. // a nastepnie w prosty sposob podzielilismy ja na mniejsze kawalki o odpowiedniej wielkosci.
  24.  
  25. ?>
#2 (25.01.2013 r.) / php (Autor: rafalwit)
  1. <?php
  2.  
  3. $url = "http://webapi.allegro.pl/uploader.php?wsdl";
  4. $user_login = "login";
  5. $user_password = "haslo";
  6. $country_code = 1;
  7. $webapi_key = "klucz";
  8.  
  9. $client = new SoapClient($url);
  10. print_r($client);
  11. $varQuery = $client->doQuerySysStatus(4, $country_code, $webapi_key) ;
  12. // $version = $client->doQueryAllSysStatus($country_code, $webapi_key);
  13. //echo "</br>version</br>" ;
  14. // print_r($version);
  15. echo "</br>varQuery</br>";
  16. print_r($varQuery) ;
  17.  
  18.  
  19. echo "</br>varQuery['ver-key']</br>";
  20. print_r($varQuery['ver-key']);
  21. $allegroVer=$varQuery['ver-key'];
  22. echo "</br>allegroVer</br>";
  23. print_r($allegroVer);
  24. // print_r($version[0]['program-version']);
  25. //$allegroVer=$version[0]=>ver-key;
  26. //print_r($var_Query[0]);
  27. // print_r($allegroVer);
  28. $local_version = $allegroVer;
  29. $client->soap_defencoding = 'UTF-8';
  30. $client->decode_utf8 = false;
  31.  
  32. $varSession = $client->doLogin($user_login,$user_password,$country_code, $webapi_key,$local_version,1,1);
  33. echo "</br>varSession</br>";
  34. print_r($varSession);
  35.  
  36. $idSesji=$varSession['session-handle-part'];
  37. echo "</br>idSesji=$idSesji</br>";
  38. $lngIlosc = $client->doMyAccountItemsCount($idSesji, "sold", $varTMP);
  39. echo "</br>lngIlosc</br>";
  40. print_r($lngIlosc);
  41. echo "</br>varTMP</br>";
  42. print_r($varTMP);
  43. $aukcje=$client->doMyAccount2($idSesji,"sold");
  44. echo "</br>aukcje</br>";
  45. print_r($aukcje);
  46.  
  47. $nr_aukcji=$aukcje[0]->{'my-account-array'}[0];
  48. $nr_aukcji_2=$aukcje[1]->{'my-account-array'}[0];
  49.  
  50. echo "</br>nr_aukcji=";
  51. echo "$nr_aukcji";
  52. echo "</br>";
  53. echo "</br>nr_aukcji=";
  54. echo "$nr_aukcji_2";
  55. echo "</br>";
  56. $tabela_ofert=array($nr_aukcji,$nr_aukcji_2);
  57. print_r($tabela_ofert);
  58. $varWyn = $client->doGetItemsInfo($idSesji, $tabela_ofert, 1, 0, 0, 0, 0, 0, 0);
  59. echo "</br>aukcje szczegoly</br>";
  60. print_r($varWyn);
  61.  
  62. ?>