Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyNotSoldItems

Tematyka: Moje Allegro
Ostatnia zmiana: 07.03.2013 r.
Dostępność:
Metoda odtwarza pełną funkcjonalność zakładki "Niesprzedane" w Moim Allegro. Dodatkowo umożliwia sortowanie oraz filtrowanie ofert a także wyszukiwanie ofert po nazwie.

  1. session-id | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. sort-options | SortOptionsStruct | niewymagany
    Struktura zawierająca informacje o sposobie sortowania ofert.
    1. sort-type | int | niewymagany
      Parametr pozwalający na określenie typu sortowania (1 - po czasie zakończenia oferty (wartość domyślna dla zakładki), 2 - po aktualnej cenie, 3 - po nazwie oferty, 4 - po ilości ofert, 5 - po najwyższej ofercie, 7 - po cenie minimalnej, 9 - po ilości sztuk wystawionych).
    2. sort-order | int | niewymagany
      Parametr pozwalający na określenie kierunku sortowania (1 - rosnąco, 2 - malejąco (wartość domyślna dla zakładki)).
  3. filter-options | NotSoldFilterOptionsStruct | niewymagany
    Struktura zawierająca informacje o sposobie filtrowania ofert.
    1. filter-format | int | niewymagany
      Parametr pozwalający na filtrowanie po formacie oferty (0 - pokaż wszystkie, 1 - tylko oferty z Allegro, 2 - tylko oferty sklepowe; domyślna wartość: 0).
    2. filter-from-end | int | niewymagany
      Parametr pozwalający na filtrowanie po czasie rozpoczęcia oferty (0 - pokaż wszystkie, 7 - 2 dni, 8 - 3 dni, 9 - 4 dni, 10 - 5 dni, 11 - 6 dni, 12 - 7 dni; domyślna wartość: 0).
    3. filter-auto-listing | int | niewymagany
      Parametr pozwalający na filtrowanie po opcji automatycznego wznawiania (0 - pokaż wszystkie, 1 - z wyłączonym autowznawianiem, 2 - tylko z autowznawianiem ofert z niesprzedanymi przedmiotami, 3 - tylko z autowznawianiem ofert z pełną pulą przedmiotów; domyślna wartość: 0).
    4. filter-price | FilterPriceStruct| niewymagany
      Struktura zawierająca informacje o sposobie filtrowania ofert po cenie.
      1. filter-price-from | float | niewymagany
        Wartość początkowa zakresu wartości parametru.
      2. filter-price-to | float | niewymagany
        Wartość końcowa zakresu wartości parametru.
  4. search-value | string | niewymagany
    Wyrażenie, na podstawie którego mają być wyszukane oferty (dotyczy tylko wyszukiwania po tytule oferty). Umożliwia wyszukiwanie przy użyciu znaków *, -, () oraz "".
  5. category-id | int | niewymagany
    Parametr pozwalający na określenie kategorii z jakiej mają zostać pokazane oferty.
  6. item-ids | long[] | niewymagany
    Tablica identyfikatorów ofert (maksimum: 100).
  7. page-size | int | niewymagany
    Parametr pozwalający na określenie ilości ofert wyświetlanych jednorazowo (minimum: 1, maksimum: 1000, domyślnie: 100).
  8. page-number | int | niewymagany
    Parametr pozwalający na wskazanie porcji danych, która ma być wyświetlona (domyślnie: 0).



    Orientacyjna struktura wywołania metody

    $dogetmynotsolditems_request = array(
       'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
       'sort-options' => array(
          'sort-type' => 2,
          'sort-order' => 1),
       'filter-options' => array(
          'filter-format' => 0,
          'filter-from-end' => 7,
          'filter-auto-listing' => 1,
          'filter-price' => array(
             'filter-price-from' => 3.50,
             'filter-price-to' => 99.10)),
       'search-value' => 'Plecak',
       'category-id' => 10925,
       'item-ids' => array(1070356993),
       'page-size' => 25,
       'page-number' => 0
    );


    1. not-sold-items-counter | int
      Liczba ofert niesprzedanych (odpowiadająca filtrom podanym na wejściu metody).
    2. not-sold-items-list | NotSoldItemsListStruct[]
      Tablica struktur zawierająca dokładne informacje o ofertach niesprzedanych.
      1. item-id | long
        Identyfikator oferty.
      2. item-title | string
        Tytuł oferty.
      3. item-thumbnail-url | string
        Odnośnik do miniaturki oferty.
      4. item-price | ItemPriceStruct[]
        Tablica struktur zawierająca informacje o cenie przedmiotu.
        1. price-type | int
          Rodzaj ceny (1 - Kup Teraz!, 2 - ostateczna cena w licytacji, 3 - cena wywoławcza w licytacji, 4 - cena minimalna w licytacji).
        2. price-value | float
          Wartość ceny przedmiotu.
      5. item-start-quantity | int
        Początkowa ilość przedmiotów w ofercie.
      6. item-quantity-type | int
        Typ dostępnych w ofercie przedmiotów (1 - sztuki, 2 - komplety, 3 - pary).
      7. item-start-time | long
        Czas rozpoczęcia oferty (Unix time).
      8. item-end-time | long
        Czas zakończenia oferty (Unix time).
      9. item-bidders-counter | int
        Licznik złożonych ofert kupna.
      10. item-highest-bidder | UserInfoStruct
        Struktura zawierająca informacje o użytkowniku z najwyższą ofertą, wypełniana tylko dla jednoprzedmiotowych licytacji.
        1. user-id | int
          Identyfikator użytkownika.
        2. user-login | string
          Nazwa użytkownika.
        3. user-rating | int
          0. Pole nieaktywne.Informacje o ocenach można pobrać przez REST API
        4. user-icons | int
          Dodatkowe informacje o użytkowniku. Maska bitowa: 1 - konto bez aktywacji, 2 - konto Junior, 4 - użytkownik niezarejestrowany, 8 - strona "O mnie", 16 - konto Firma, 32 - sklep, 64 - Super Sprzedawca (tylko dla molotok.ru).
        5. user-country | int
          Identyfikator kraju użytkownika.
      11. item-category-id | int
        Identyfikator kategorii w której jest wystawiona oferta.
      12. item-watchers-counter | int
        Liczba użytkowników obserwujących ofertę.
      13. item-views-counter | int
        Liczba wyświetleń oferty.
      14. item-note | string
        Treść notatki do oferty.
      15. item-special-info | int
        Informacja o tym, czy oferta jest oznaczona jako Standard Allegro [PL], Aukro Plus [CZ] lub Super Offer [UA/KZ] (0 - nie jest, 1 - jest).
      16. item-shop-info | int
        Informacja o tym, czy oferta jest sklepowa (0 - nie jest, 1 - jest).
      17. item-product-info | long
        Pole zdezaktualizowane (zawsze będzie zwracać 0).
      18. item-payu-info | int
        Informacja o tym, czy w ofercie jest dostępny sposób płatności PayU (0 - nie jest, 1 - jest).



    Orientacyjna struktura odpowiedzi serwera

    $dogetmynotsolditems_response = array(
       'not-sold-items-counter' => 1,
       'not-sold-items-list' => array(
         array(
          'item-id' => 1070362941,
          'item-title' => 'Plecak na wycieczkę',
          'item-thumbnail-url' => 'http://img06.allegroimg.pl/photos/1966835519',
          'item-price' => array(
            array(
             'price-type' => 2,
             'price-value' => 69.99),
            array(
             'price-type' => 3,
             'price-value' => 10.00),
            array(
             'price-type' => 4,
             'price-value' => 99.00)),
          'item-start-quantity' => 1,
          'item-quantity-type' => 1,
          'item-start-time' => 1326373020,
          'item-end-time' => 1326977820,
          'item-bidders-counter' => 1,
          'item-highest-bidder' => array(,
            'user-id' => 486381,
            'user-login' => 'm010ch',
            'user-rating' => 0,
            'user-icons' => 8,
            'user-country' => 1),
          'item-category-id' => 10563,
          'item-watchers-counter' => 3,
          'item-views-counter' => 29,
          'item-note' => 'Treść notatki',
          'item-special-info' => 0,
          'item-shop-info' => 0,
          'item-product-info' => 0,
          'item-payu-info' => 1))
    );


    • ERR_INCORRECT_CATEGORY_ID
      Nieprawidłowy identyfikator kategorii.
    • ERR_INCORRECT_FILTER_AUTO_LISTING
      Nieprawidłowa wartość w parametrze filter-auto-listing.
    • ERR_INCORRECT_FILTER_FORMAT
      Nieprawidłowa wartość w parametrze filter-format.
    • ERR_INCORRECT_FILTER_FROM_END
      Nieprawidłowa wartość w parametrze filter-from-end.
    • ERR_INCORRECT_FILTER_PRICE_FROM
      Nieprawidłowa wartość w parametrze filter-price-from (mniejsza niż 0).
    • ERR_INCORRECT_FILTER_PRICE_RANGE
      Nieprawidłowa wartość w parametrze filter-price-range (wartość początkowa zakresu jest większa od wartości końcowej zakresu).
    • ERR_INCORRECT_FILTER_PRICE_TO
      Nieprawidłowa wartość w parametrze filter-price-to (mniejsza niż 0).
    • ERR_INCORRECT_PAGE_NUMBER
      Nieprawidłowa wartość w parametrze page-number (mniejsza niż 0).
    • ERR_INCORRECT_PAGE_SIZE
      Nieprawidłowa wartość w parametrze page-size (mniejsza niż 0 lub większa niż 1000).
    • ERR_INCORRECT_SEARCH_VALUE
      Wyszukiwana fraza zawiera niedozwolone znaki.
    • ERR_INCORRECT_SORT_ORDER
      Nieprawidłowa wartość w parametrze sort-order.
    • ERR_INCORRECT_SORT_TYPE
      Nieprawidłowa wartość w parametrze sort-type.
    • ERR_NO_SESSION / ERR_SESSION_EXPIRED
      Niepoprawny identyfikator sesji lub sesja wygasła.
    • ERR_TOO_MANY_ITEM_IDS
      Przekazano więcej niż 100 identyfikatorów ofert.
    • 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).

    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.