Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetPostBuyFormsIds

Ostatnia zmiana: ---
Dostępność:
Metoda zwraca identyfikatory formularzy pozakupowych (wraz z dopłatami), powiązanych z użytkownikiem będącym właścicielem sesji. Możliwe jest filtrowanie danych na wiele różnych sposobów (m.in. po identyfikatorach ofert/użytkowników/metod płatności, ciągu znaków w tytule, statusie płatności czy czasie utworzenia formularza). Logika działania metody została oparta na systemie dynamicznych filtrów, zwracanych kontekstowo i pozwalających precyzyjnie sterować zakresem zwracanych danych. Tutorial opisujący zasadę działania dynamicznych filtrów znajduje się pod adresem: https://allegro.pl/webapi/tutorials.php/tutorial/id,281. Metoda zwraca dane z ostatnich dwóch miesięcy, posortowane malejąco po dacie wypełnienia formularza.

  1. sessionId | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. filterOptions | FilterOptionsType[] | niewymagany
    Kryteria filtrowania wyników (lista możliwych do ustawienia w danym kontekście filtrów, zwracana jest na wyjściu metody w ramach struktury filtersList).
    1. filterId | string | niewymagany
      Identyfikator filtra.
    2. filterValueId | string[] | niewymagany
      Identyfikator(y) wartości filtra (dla filtrów pojedynczych lub wielokrotnych).
    3. filterValueRange | RangeValueType | niewymagany
      Zakres wartości filtra (dla filtrów zakresowych).
      1. rangeValueMin | string | niewymagany
        Minimalna wartość filtra.
      2. rangeValueMax | string | niewymagany
        Maksymalna wartość filtra.
  3. resultSize | int | niewymagany
    Rozmiar porcji danych (min. 1, maks. 1000). Domyślna wartość: 100.
  4. resultOffset | int | niewymagany
    Sterowanie pobieraniem kolejnych porcji danych. Domyślna wartość: 0.



Orientacyjna struktura wywołania metody

$dogetpostbuyformsids_request = array(
   'sessionId' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'filterOptions' => array(
     array(
      'filterId' => 'userRole',
      'filterValueId' => array('buyer'))),
);


  1. formsCount | int
    Liczba znalezionych formularzy pozakupowych (także anulowanych) oraz dopłat do nich.
  2. formsIds | long[]
    Lista identyfikatorów formularzy.
  3. filtersList | FilterListType[]
    Informacje o filtrach możliwych do ustawienia w danym kontekście.
    1. filterId | string
      Identyfikator filtra.
    2. filterName | string
      Nazwa filtra (do wyświetlenia w aplikacji).
    3. filterType | string
      Typ filtra: country - filtr globalny dla danego serwisu/kraju, category - filtr istniejący tylko w ramach przekazanej kategorii (parametr). Wszystkie filtry dostępne w ramach doGetPostBuyFormsIds są typu country.
    4. filterControlType | string
      Typ kontrolki potrzebnej do wyświetlenia filtra: combobox (do wyboru pojedyncza wartość z listy), checkbox (do wyboru wiele wartości z listy), textbox (wartość do samodzielnego uzupełnienia).
    5. filterDataType | string
      Typ danych jakie przyjmuje filtr: string, int, long, float, datetime.
    6. filterIsRange | boolean
      Informacja o tym czy parametr jest typu zakresowego: true/false.
    7. filterArraySize | int
      Maksymalna liczba wartości jaką można przekazać dla danego filtra (zwracana tylko dla filtrów wielokrotnych).
    8. filterValues | FilterValueType[]
      Informacje o wartościach filtrów.
      1. filterValueId | string
        Identyfikator wartości filtra.
      2. filterValueName | string
        Nazwa wartości filtra (do wyświetlenia w aplikacji).
      3. filterValueCount | int
        Liczba ofert pasujących do danego filtra (zwracana tylko gdy jest możliwa do wyliczenia w danym kontekście).
    9. filterRelations | FilterRelationType
      Informacje o relacjach między filtrami.
      1. relationAnd | string[]
        Lista wszystkich identyfikatorów filtrów, z którymi dany filtr musi zostać użyty.
      2. relationOr | string[]
        Lista identyfikatorów filtrów, spośród których co najmniej jeden musi być użyty z danym filtrem.
      3. relationExclude | string[]
        Lista identyfikatorów filtrów, z którymi dany filtr nie może zostać użyty.



Orientacyjna struktura odpowiedzi serwera

$dogetpostbuyformsids_response = array(
   'formsCount' => 2,
   'formsIds' => array(293535261, 291573741),
   'filtersList' => array(
      array(
        'filterId' => 'userRole',
        'filterName' => 'Rola użytkownika w transakcji',
        'filterType' => 'country',
        'filterControlType' => 'combobox',
        'filterDataType' => 'string',
        'filterIsRange' => false,
        'filterValues' => array(
           array(
             'filterValueId' => 'seller',
             'filterName' => 'Sprzedający'),
           array(
             'filterValueId' => 'buyer',
             'filterName' => 'Kupujący'))),
      array(
        'filterId' => 'search',
        'filterName' => 'Szukaj w tytule',
        'filterType' => 'country',
        'filterControlType' => 'textbox',
        'filterDataType' => 'string',
        'filterIsRange' => false,
        'filterRelations' => array(
             'relationAnd' => array('userRole'))),
      array(...))
);


  • ERR_FILTER_DEPENDENCY_ALL
    Filtr nie może zostać użyty bez przekazania dodatkowo wszystkich podanych filtrów: lista filtrów.
  • ERR_FILTER_DEPENDENCY_AT_LEAST_ONE
    Filtr nie może zostać użyty bez przekazania dodatkowo przynajmniej jednego z podanych filtrówlista filtrów.
  • ERR_FILTER_DEPENDENCY_MISMATCH
    Filtr nie może zostać użyty jednocześnie z przynajmniej jednym z podanych filtrówlista filtrów.
  • ERR_INCORRECT_FILTER_ID
    Filtr o podanym identyfikatorze nie istnieje (wcale lub w bieżącym kontekście).
  • ERR_INCORRECT_FILTER_VALUE
    Niepoprawna wartość identyfikatora wartości filtra (dla filtra pojedynczego, wielokrotnego lub zakresowego).
  • ERR_INCORRECT_RESULT_SIZE
    Niepoprawna wartość rozmiaru porcji danych (spoza zakresu 1-1000).
  • ERR_INCORRECT_RESULT_OFFSET
    Niepoprawna wartość offsetu (mniejsza od 0).
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_TOO_MANY_FILTER_VALUES
    Liczba podanych filtrów przekracza dopuszczalny limit (maks. 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).