Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetItemTemplates

Tematyka: Szablony
Ostatnia zmiana: 14.02.2012 r.
Dostępność:
Metoda pozwala na pobranie szablonów ofert, zapisanych na koncie zalogowanego użytkownika.

  1. session-id | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. item-template-ids | int[] | niewymagany
    Tablica identyfikatorów szablonów ofert (jeżeli pusta, zwracane są wszystkie szablony zalogowanego użytkownika).



Orientacyjna struktura wywołania metody

$dogetitemtemplates_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'item-template-ids' => array(1049183, 9876543)
);

  1. item-templates | ItemTemplatesStruct
    Struktura zawierająca informacje o szablonach ofert.
    1. item-template-list | ItemTemplateListStruct[]
      Tablica struktur zawierających informacje o szablonach ofert zalogowanego użytkownika.
      1. item-template-id | int
        Identyfikator szablonu oferty.
      2. item-template-name | string
        Nazwa szablonu oferty.
      3. item-template-fields | FieldsValue[]
        Tablica struktur zawierających informacje o ustawieniu poszczególnych pól formularza sprzedaży składających sie na szablon oferty.
        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. item-template-incorrect-ids | int[]
      Tablica niepoprawnych (nieistniejących w kontekście zalogowanego użytkownika) identyfikatorów szablonów ofert (dotyczy identyfikatorów przekazanych w item-template-ids).



Orientacyjna struktura odpowiedzi serwera

$dogetitemtemplates_response = array(
   'item-templates' => array(
      'item-template-list' => array(
         array(
            'item-template-id' => 1049183,
            'item-template-name' => 'Szablon testowy',
            'item-template-fields' => array(
               array(
                  'fid' => 1,
                  'fvalue-string' => 'Tytuł testowego szablonu',
                  '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,
                  'fvalue-string' => '',
                  'fvalue-int' => 92906,
                  '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' => ''))))),

      'item-template-incorrect-ids' => array(9876543))
);

  • 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).

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.