Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetMyFutureItems

Tematyka: Moje Allegro
Ostatnia zmiana: 07.03.2013 r.
Dostępność:
Metoda odtwarza pełną funkcjonalność zakładki "Do wystawienia" w Moim Allegro. Dodatkowo umożliwia sortowanie oraz filtrowanie ofert zaplanowanych do wystawienia.

  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 (3 - po nazwie oferty, 13 - po dacie rozpoczęcia oferty (wartość domyślna dla zakładki)).
    2. sort-order | int | niewymagany
      Parametr pozwalający na określenie kierunku sortowania (1 - rosnąco (wartość domyślna dla zakładki), 2 - malejąco).
  3. filter-options | FutureFilterOptionsStruct | 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 oferty, 1 - tylko oferty z Allegro, 2 - tylko oferty sklepowe; domyślna wartość: 0).
  4. category-id | int | niewymagany
    Parametr pozwalający na określenie kategorii z jakiej mają zostać pokazane oferty.
  5. item-ids | long[] | niewymagany
    Tablica identyfikatorów ofert (maksimum: 100).
  6. page-size | int | niewymagany
    Parametr pozwalający na określenie ilości ofert wyświetlanych jednorazowo (minimum: 1, maksimum: 1000, domyślnie: 100).
  7. 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

$dogetmyfutureitems_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'sort-options' => array(
      'sort-type' => 3,
      'sort-order' => 2),
   'filter-options' => array(
      'filter-format' => 0),
   'category-id' => 10563,
   'item-ids' => array(1070356993),
   'page-size' => 25,
   'page-number' => 0
);


  1. future-items-counter | int
    Liczba ofert zaplanowanych do wystawienia (odpowiadająca filtrom podanym na wejściu metody).
  2. future-items-list | FutureItemStruct[]
    Tablica struktur zawierająca dokładne informacje o ofertach zaplanowanych do wystawienia.
    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!, 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-category-id | int
      Identyfikator kategorii w której jest wystawiona oferta.
    9. item-note | string
      Treść notatki do oferty.
    10. 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).
    11. item-shop-info | int
      Informacja o tym, czy oferta jest sklepowa (0 - nie jest, 1 - jest).
    12. item-product-info | long
      Pole zdezaktualizowane (zawsze będzie zwracać 0).
    13. item-payu-info | int
      Informacja o tym, czy w ofercie jest dostępny sposób płatności PayU (0 - nie jest, 1 - jest).
    14. item-status | int
      Informacja o statusie oferty (1 - Oczekuje na wystawienie, 2 - Nie zostanie wystawiona. Została wstrzymana przez administratora Allegro lub zawiera niedozwolone pola/wartości w polach).



Orientacyjna struktura odpowiedzi serwera

$dogetmyfutureitems_response = array(
   'future-items-counter' => 1,
   'future-items-list' => array(
     array(
      'item-id' => 1070374582,
      'item-title' => 'Piórnik',
      'item-thumbnail-url' => 'http://img06.allegroimg.pl/photos/1070374582',
      'item-price' => array(
        array(
         'price-type' => 1,
         'price-value' => 49.99)),
      'item-start-quantity' => 1,
      'item-quantity-type' => 1,
      'item-start-time' => 1339583514,
      'item-category-id' => 10563,
      'item-note' => 'Treść notatki',
      'item-special-info' => 0,
      'item-shop-info' => 0,
      'item-product-info' => 0,
      'item-payu-info' => 1,
      'item-status' => 1))
);


  • ERR_INCORRECT_CATEGORY_ID
    Nieprawidłowy identyfikator kategorii.
  • 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_FILTER_FORMAT
    Nieprawidłowa wartość w parametrze filter-format.
  • 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).