Podstawowym i rozwijanym API Allegro jest REST API. Skorzystaj z niego, jeśli tworzysz nową aplikację lub myślisz o rozwoju obecnej. WebAPI to stare rozwiązanie, które utrzymujemy głównie z uwagi na kompatybilność wsteczną z istniejącymi aplikacjami. Nie rozwijamy go już i planujemy jego wygaszenie. Wszelkie nowe funkcjonalności wdrażamy tylko na REST API.

Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetSellFormFieldsForCategory (deprecated) USUNIEMY 3.06

Ostatnia zmiana: 29.09.2011 r.
Dostępność:
3 czerwca 2019 usuniemy metody do obsługi i zarządzania ofertami, które oznaczyliśmy jako deprecated. Oznacza to, że już teraz odradzamy użycia tych metod w nowych rozwiązaniach i zalecamy migrację na REST API w istniejących rozwiązaniach. Metoda pozwala na pobranie listy pól formularza sprzedaży dostępnych we wskazanym kraju, we wskazanej kategorii. Każdorazowo zwracane są pola stałe dla wszystkich kategorii oraz lista parametrów możliwa do ustawienia w kategorii podanej na wejściu (tylko jeżeli wskazana kategoria jest liściem). Wybrane pola mogą następnie posłużyć np. do zbudowania i wypełnienia formularza wystawienia nowej oferty z poziomu metody doNewAuctionExt.

  1. webapi-key | string | wymagany
    Klucz WebAPI użytkownika.
  2. country-id | int | wymagany
    Identyfikator kraju (listę identyfikatorów krajów uzyskać można za pomocą metody doGetCountries).
  3. category-id | int | wymagany
    Identyfikator kategorii najniższego rzędu (listę identyfikatorów kategorii uzyskać można za pomocą metody doGetCatsData(Limit)).



Orientacyjna struktura wywołania metody

$dogetsellformfieldsforcategory_request = array(
   'webapi-key' => 'g2fe408289',
   'country-id' => 1,
   'category-id' => 92906
);

  1. sell-form-fields-for-category | SellFormFieldsForCategoryStruct
    Struktura zawierająca informacje o polach formularza sprzedaży dla kategorii.
    1. sell-form-fields-list | SellFormType[]
      Tablica struktur zawierająca szczegółowe informacje o polach formularza sprzedaży dla kategorii.
      1. sell-form-id | int
        Identyfikator pola.
      2. sell-form-title | string
        Nazwa pola.
      3. sell-form-cat | int
        Identyfikator kategorii, do której odnosi się pole (dotyczy też wszystkich podkategorii wskazanej kategorii). 0 oznacza, że parametr odnosi się do wszystkich kategorii.
      4. sell-form-type | int
        Określenie typu pola w formularzu sprzedaży (1 - string, 2 - integer, 3 - float, 4 - combobox, 5 - radiobutton, 6 - checkbox, 7 - image (base64Binary), 8 - text (textarea), 9 - datetime (Unix time), 13 - date).
      5. sell-form-res-type | int
        Wskazanie na typ pola, w którym należy przekazać wybraną wartość pola (1 - string, 2 - integer, 3 - float, 7 - image (base64Binary), 9 - datetime (Unix time), 13 - date).
      6. sell-form-def-value | int
        Domyślna wartość pola (dla pól typu combobox/radiobutton/checkbox - na podstawie sell-form-opts-values).
      7. sell-form-opt | int
        Informacja na temat obligatoryjności pola (1 - pole obowiązkowe, 8 - pole opcjonalne).
      8. sell-form-pos | int
        Pozycja pola na liście pól w formularzu sprzedaży. 0 oznacza, że stosowane jest sortowanie alfabetyczne.
      9. sell-form-length | int
        Dopuszczalny rozmiar (w znakach) przekazywanej wartości pola.
      10. sell-min-value | string
        Minimalna możliwa do przekazania wartość pola (dot. pól typu: int, float, combobox, checkbox, date; wartość 0 wskazuje na brak dolnego ograniczenia).
      11. sell-max-value | string
        Maksymalna możliwa do przekazania wartość pola (dot. pól typu: int, float, combobox, checkbox, date; wartość 0 wskazuje na brak górnego ograniczenia).
      12. sell-form-desc | string
        Opis kolejnych wartości, które można ustawić dla pola (dot. pól typu combobox/radiobutton/checkbox).
      13. sell-form-opts-values | string
        Wskazanie konkretnych wartości (odpowiednich dla opisów wyżej), które można ustawić dla danego pola (dot. pól typu combobox/radiobutton/checkbox, dla pól typu checkbox kolejne wartości można sumować).
      14. sell-form-field-desc | string
        Szczegółowy opis pola.
      15. sell-form-param-id | int
        Unikalny identyfikator pola.
      16. sell-form-param-values | string
        Unikalne i niezmienne identyfikatory wartości parametru (dot. pól typu combobox/radiobutton/checkbox).
      17. sell-form-parent-id |int
        Identyfikator parametru rodzica (jego sell-form-param-id - tylko dla parametrów zależnych nie będących na szczycie hierarchi. Jeżeli dany parametr nie jest parametrem zależnym, lub jeżeli znajduje się na szczycie hierarchi parametrów zależnych - w polu zwracana zostanie wartość 0).
      18. sell-form-parent-value | string
        Wartość parametru rodzica, dla której parametr powiązany może być wykorzystany (tylko dla parametrów zależnych. Jeżeli dany parametr nie jest parametrem zależnym - w polu nie zostanie zwrócona żadna wartość).
      19. sell-form-unit | string
        Jednostka parametru (jeżeli została określona).
      20. sell-form-options | int
        Dodatkowe własności parametru: 1 - parametr zależny; 2 - parametr typu checkbox z wykorzystaniem operatora OR (z możliwym wyborem jednej lub wielu wartości), w przypadku gdy ta wartość nie jest ustawiona działanie parametru opiera się na operatorze AND; 6 - parametr typu checkbox z możliwym wyborem pojedynczej wartości (w praktyce combobox); 8 - parametr zakresowy.
    2. sell-form-fields-version-key | long
      Wartość klucza wersji odpowiednia dla wybranego kraju i przekazanego klucza WebAPI.
    3. sell-form-fields-component-value | string
      Wersja komponentu pól formularza sprzedaży odpowiednia dla przekazanego klucza WebAPI.



Orientacyjna struktura odpowiedzi serwera

$dogetsellformfieldsforcategory_response = array(
   'sell-form-fields-for-category' => array(
      'sell-form-fields-list' => array(
         array(...),
         array(
            'sell-form-id' => 2,
            'sell-form-title' => 'Kategoria',
            'sell-form-cat' => 0,
            'sell-form-type' => 12,
            'sell-form-res-type' => 2,
            'sell-form-def-value' => 0,
            'sell-form-opt' => 1,
            'sell-form-pos' => 2,
            'sell-form-length' => 500,
            'sell-min-value' => 1.00,
            'sell-max-value' => 0.00,
            'sell-form-desc' => '',
            'sell-form-opts-values' => '',
            'sell-form-field-desc' => 'Dokładnie określ kategorię przedmiotu',
            'sell-form-param-id' => 0,
            'sell-form-param-values' => '',
            'sell-form-parent-id' => 0,
            'sell-form-parent-value' => '',
            'sell-form-unit' => '',
            'sell-form-options' => 0),
         array(...),
         array(
            'sell-form-id' => 4,
            'sell-form-title' => 'Czas trwania',
            'sell-form-cat' => 0,
            'sell-form-type' => 4,
            'sell-form-res-type' => 2,
            'sell-form-def-value' => 2,
            'sell-form-opt' => 1,
            'sell-form-pos' => 4,
            'sell-form-length' => 1,
            'sell-min-value' => 0.00,
            'sell-max-value' => 5.00,
            'sell-form-desc' => '3|5|7|10|14|30',
            'sell-form-opts-values' => '0|1|2|3|4|5',
            'sell-form-field-desc' => 'Przy wystawieniu na 14 dni - pobierana jest opłata 0,20 zł.',
            'sell-form-param-id' => 0,
            'sell-form-param-values' => '',
            'sell-form-parent-id' => 0,
            'sell-form-parent-value' => '',
            'sell-form-unit' => '',
            'sell-form-options' => 0 ),
         array(...),
         array(
            'sell-form-id' => 3372,
            'sell-form-title' => 'Stan',
            'sell-form-cat' => 79413,
            'sell-form-type' => 4,
            'sell-form-res-type' => 2,
            'sell-form-def-value' => 0,
            'sell-form-opt' => 8,
            'sell-form-pos' => 0,
            'sell-form-length' => 1,
            'sell-min-value' => 0.00,
            'sell-max-value' => 3.00,
            'sell-form-desc' => ' -- Wybierz -- |bez śladów użycia|używany|nowy',
            'sell-form-opts-values' => '0|1|2|3',
            'sell-form-field-desc' => '',
            'sell-form-param-id' => 2867,
            'sell-form-param-values' => '0|1|2|3',
            'sell-form-parent-id' => 0,
            'sell-form-parent-value' => '',
            'sell-form-unit' => '',
            'sell-form-options' => 0 ),
         array(...),
         array(
            'sell-form-id' => 3478,
            'sell-form-title' => 'Cechy',
            'sell-form-cat' => 79413,
            'sell-form-type' => 6,
            'sell-form-res-type' => 2,
            'sell-form-def-value' => 0,
            'sell-form-opt' => 8,
            'sell-form-pos' => 0,
            'sell-form-length' => 1,
            'sell-min-value' => 0.00,
            'sell-max-value' => 7.00,
            'sell-form-desc' => 'twarda okładka|czarno-biały|kredowy papier',
            'sell-form-opts-values' => '1|2|4',
            'sell-form-field-desc' => '',
            'sell-form-param-id' => 5126,
            'sell-form-param-values' => '1|2|4',
            'sell-form-parent-id' => 0,
            'sell-form-parent-value' => '',
            'sell-form-unit' => '',
            'sell-form-options' => 0 )),

      'sell-form-fields-version-key' => 25319881,
      'sell-form-fields-component-value' => '1.1.18')
);

  • ERR_INCORRECT_CATEGORY_ID
    Niepoprawny identyfikator kategorii.
  • ERR_INPUT_COUNTRY_ERROR
    Niepoprawny identyfikator kraju (wskazany kraj nie jest obsługiwany lub w parametrze przekazano zerową/pustą wartość).
  • ERR_NO_DATABASE
    Problemy z bazą danych Allegro.
  • ERR_WEBAPI_CATEGORY_IS_NOT_LEAF
    Podany identyfikator kategorii jest nieprawidłowy.
  • 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 został zdezaktywowany (nie zaakceptowano warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.
  • ERR_STANDARDIZED_DESCRIPTION_REQUIRED_FOR_ADVERTISEMENT
    Ogłoszenie musi zawierać nowy opis oferty.