Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetItemFields

Ostatnia zmiana: 13.03.2012 r.
Dostępność:
Metoda służy do pobierania informacji o ofercie zalogowanego użytkownika w postaci pól formularza sprzedaży. Dane zwracane przez metodę mogą być następnie przesłane w strukturze fields na wejściu doNewAuctionExt, dzięki czemu możliwe będzie wystawienie nowej oferty na podstawie oferty trwającej. Należy mieć na uwadze, że zdjęcia zwrócone przez metodę będą już w postaci skompresowanej przez mechanizmy działające przy wystawianiu oferty, a opis oferty zwrócony zostanie w formie przepuszczonej uprzednio przez nasze walidatory. Należy również pamiętać, że dane wejściowe metody doNewAuctionExt i oraz dane wyjściowe metody doGetItemFields nigdy nie będą identyczne, z uwagi na to że doGetItemFields zwraca dane o ofercie w postaci w jakiej przechowywane są one w serwisie, a nie w takiej w jakiej wysyłał je użytkownik wystawiając ofertę.

  1. session-id |  string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. item-id | long | wymagany
    Identyfikator oferty, dla której mają zostać zwrócone dane.



Orientacyjna struktura wywołania metody

$dogetitemfields_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'item-id' => 1048196513
);

  1. item-fields | FieldsValue[]
    Tablica struktur zawierających informacje o ofercie w postaci pól formularza sprzedaży.
    1. fid | int
      Identyfikator pola.
    2. fvalue-string | string
      Wartość pola dla typu tekstowego.
    3. fvalue-int | int
      Wartość pola dla liczb całkowitych.
    4. fvalue-float | float
      Wartość pola dla liczb zmiennoprzecinkowych.
    5. fvalue-image | base64Binary
      Wartość pola dla plików graficznych.
    6. fvalue-datetime | float
      Wartość pola dla dat i czasu (Unix time).
    7. fvalue-date | string
      Wartość pola dla dat (DD-MM-YYYY).
    8. fvalue-range-int | RangeIntValueStruct
      Wartość pola dla liczb całkowitych typu zakresowego.
              1. fvalue-range-int-min | int
                  Wartość początkowa zakresu wartości parametru.
              2. fvalue-range-int-max | int
                  Wartość końcowa zakresu wartości parametru.
    9. fvalue-range-float | RangeFloatValueStruct
      Wartość pola dla liczb rzeczywistych typu zakresowego.
              1. fvalue-range-float-min | float
                  Wartość początkowa zakresu wartości parametru.
              2. fvalue-range-float-max | float
                  Wartość końcowa zakresu wartości parametru.
    10. fvalue-range-date | RangeDateValueStruct
      Wartość pola dla dat typu zakresowego.
              1. fvalue-range-date-min | string
                  Wartość początkowa zakresu wartości parametru.
              2. fvalue-range-date-max | string
                  Wartość końcowa zakresu wartości parametru.
  2. 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.
  3. additionalServicesGroup  | string | non-required
    Identyfikator (uuid) grupy usług dodatkowych. Możesz go sprawdzić zasobem GET /sale/offer-additional-services/groups/{groupId}  w REST API.



    Orientacyjna struktura odpowiedzi serwera

    $dogetitemfields_response = array(
       'item-fields' => array(
          array(
             'fid' => 1,   // Tytuł [Oferta testowa]
             'fvalue-string' => 'Oferta testowa',
             'fvalue-int' => 0,
             'fvalue-float' => 0,
             'fvalue-image' => 0,
             'fvalue-datetime' => 0,
             'fvalue-date' => '',
             'fvalue-range-int' => array(
                    '
    fvalue-range-int-min' => 0,
                    'fvalue-range-int-max' => 0),
             'fvalue-range-float' => array(
                    '
    fvalue-range-float-min' => 0,
                    'fvalue-range-float-max' => 0),
             'fvalue-range-date' => array(
                    'fvalue-range-date-min' => '',
                    'fvalue-range-date-max' => '')),
          array(
             'fid' => 2,   // Kategoria [Pozostałe > Pozostałe > Pozostałe]
             'fvalue-string' => '',
             'fvalue-int' => 1051,
             'fvalue-float' => 0,
             'fvalue-image' => 0,
             'fvalue-datetime' => 0,
             'fvalue-date' => '',
             'fvalue-range-int' => array(
                    '
    fvalue-range-int-min' => 0,
                    'fvalue-range-int-max' => 0),
             'fvalue-range-float' => array(
                    '
    fvalue-range-float-min' => 0,
                    'fvalue-range-float-max' => 0),
             'fvalue-range-date' => array(
                    'fvalue-range-date-min' => '',
                    'fvalue-range-date-max' => '')),
          array(
             'fid' => 4,   // Czas trwania [7]
             'fvalue-string' => '',
             'fvalue-int' => 2,
             'fvalue-float' => 0,
             'fvalue-image' => 0,
             'fvalue-datetime' => 0,
             'fvalue-date' => '',
             'fvalue-range-int' => array(
                    '
    fvalue-range-int-min' => 0,
                    'fvalue-range-int-max' => 0),
             'fvalue-range-float' => array(
                    '
    fvalue-range-float-min' => 0,
                    'fvalue-range-float-max' => 0),
             'fvalue-range-date' => array(
                    'fvalue-range-date-min' => '',
                    'fvalue-range-date-max' => '')),
          array(
             'fid' => 5,   // Liczba sztuk [1]
             'fvalue-string' => '',
             'fvalue-int' => 1,
             'fvalue-float' => 0,
             'fvalue-image' => 0,
             'fvalue-datetime' => 0,
             'fvalue-date' => '',
             'fvalue-range-int' => array(
                    '
    fvalue-range-int-min' => 0,
                    'fvalue-range-int-max' => 0),
             'fvalue-range-float' => array(
                    '
    fvalue-range-float-min' => 0,
                    'fvalue-range-float-max' => 0),
             'fvalue-range-date' => array(
                    'fvalue-range-date-min' => '',
                    'fvalue-range-date-max' => '')),
          array(...)))
    );

    • ERR_BLOCKED_USER_CANT_INVOKE_METHOD
      Użytkownik ma zablokowane konto.
    • ERR_INCORRECT_ITEM_ID
      Niepoprawny identyfikator oferty, oferta nie istnieje, została wystawiona przez innego użytkownika niż zalogowany, została przeniesiona do archiwum lub usunięta przez administratora serwisu.
    • 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).