Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetStatesInfo

Tematyka: Różne
Ostatnia zmiana: ---
Dostępność:
Metoda pozwala na pobranie listy regionów (dla Polski - województw) dla danego kraju.

  1. country-code | int | wymagany
    Identyfikator kraju (listę identyfikatorów krajów uzyskać można za pomocą metody doGetCountries).
  2. webapi-key | string | wymagany
    Klucz WebAPI użytkownika.



Orientacyjna struktura wywołania metody

$dogetstatesinfo_request = array(
   'country-code' => 1,
   'webapi-key' => 'g2fe408289'
);

  1. states-info-array | StateInfoStruct[]
    Tablica struktur zawierających informacje o regionach
    1. state-id | int
      Identyfikator regionu.
    2. state-name | string
      Nazwa regionu.



Orientacyjna struktura odpowiedzi serwera

$dogetstatesinfo_response = array(
   'states-info-array' => array(
      array(
         'state-id' => 1,
         'state-name' => 'dolnośląskie'),
      array(
         'state-id' => 2,
         'state-name' => 'kujawsko-pomorskie'),
      array(
         'state-id' => 3,
         'state-name' => 'lubelskie'),
      array(
         'state-id' => 4,
         'state-name' => 'lubuskie'),
      array(
         'state-id' => 5,
         'state-name' => 'łódzkie'),
      array(...))
);

  • ERR_INPUT_COUNTRY_ERROR
    Niepoprawny identyfikator kraju (wskazany kraj nie jest obsługiwany lub w parametrze przekazano zerową/pustą wartość).
  • 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).