Metoda product.option.list
Pobiera informacje o liście wariantów produktów
array call(string $session_id, "product.option.list", array($extended = false, $stocks = ""))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- extended (bool) - - czy zwrócić tylko listę identyfikatorów obiektów (false), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (true)
- stocks (array) - - tablica identyfikatorów obiektów do pobrania
Wartość zwracana
- (array) - jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów.
- (array) - jeśli parametr extended ustawiony jest na true, zwracana jest tablica (wektor) o długości tablicy podanej jako drugi parametr metody. Wektor składa się z tablic asocjacyjnych o strukturze:
- ['stock_id'] (int) - identyfikator wariantu
- ['product_id'] (int) - identyfikator produktu
- ['extended'] (int[0/1]) - flaga określająca, czy obiekt jest wariantem podstawowym (0), czy wariantem określanym przez zestaw cech (1)
- ['price'] (double) - cena lub różnica ceny w stosunku do ceny wariantu podstawowego - zawsze dodatnia
- ['price_type'] (int) - typ obliczania ceny (0 - brak ustalonej ceny, 1 - nowa cena wariantu, 2 - cena zostanie dodana do ceny podstawowej, 3 - cena zostanie odjęta od ceny podstawowej)
- ['active'] (int[0/1]) - aktywność wariantu produktu
- ['default'] (int[0/1]) - czy wariant produktu ma być domyślnie zaznaczonym wariantem przy wyborze
- ['stock'] (float) - stan magazynowy
- ['warn_level'] (float) - alarm magazynowy
- ['sold'] (float) - ilość sprzedanego towaru
- ['weight'] (float) - waga towaru
- ['weight_type'] (int) - typ obliczania wagi (0 - brak ustalonej wagi, 1 - nowa waga wariantu, 2 - waga zostanie dodana do wagi podstawowej, 3 - waga zostanie odjęta od wagi podstawowej)
- ['availability_id'] (int) - identyfikator dostępności wariantu
- ['delivery_id'] (int]) - identyfikator czasu dostawy wariantu
- ['gfx_id'] (int|null) - identyfikator zdjęcia produktu, które przedstawia dany wariant
- ['options'] (array) - tablica zawierająca informacje o zestawie cech, które przedstawia dany wariant. Kluczami tablicy są identyfikatory cech, a wartościami identyfikatory wariantów wybranej cechy
Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość array('error' ⇒ -2) - to oznacza, że skrypt po stronie serwera nie miał już czasu na wykonanie żądanych operacji na obiektach (poprzednie iteracje przekroczyły 80% całego dostępnego czasu na wykonanie skryptu). W celu zdobycia oczekiwanych informacji, należy ponowić zapytanie wysyłając tablicę pominiętych obiektów.
W celu zapewnienia kompatybilności typów zwracanych obiektów kod błędu jest sygnalizowany przez tablicę asocjacyjną zawierającą klucz 'error'
Rzucane wyjątki SoapFault
- W przypadku próby pobrania informacji o nieistniejącym wariancie produktu, rzucany jest wyjątek z komunikatem product stock identified as id: {$id} does not exist
Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)
Przykład wywołania w PHP
<?php /** * Logowanie do API * * @param resource $c cURL resource handle * @param string $login Login użytkownika * @param string $password Hasło użytkownika * @return string Indentyfikatorr sesji użytkownika */ function login($c, $login, $password) { $params = Array( "method" => "login", "params" => Array($login, $password) ); curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params)); $result = (Array) json_decode(curl_exec($c)); if (isset($result['error'])) { return null; } else { return $result[0]; } } $c = curl_init(); curl_setopt($c, CURLOPT_URL, 'http://shop.example.com/webapi/json/'); curl_setopt($c, CURLOPT_POST, true); curl_setopt($c, CURLOPT_RETURNTRANSFER, 1); // zalogowanie użytkownika i pobranie identyfikatora sesji $session = login($c, "api", "test"); if ($session != null) { $params = Array( "method" => "call", "params" => Array($session, "product.option.list", Array(true, Array(138, 140)) // id wariantów ) ); // zakodowanie parametrów dla metody POST $postParams = "json=" . json_encode($params); curl_setopt($c, CURLOPT_POSTFIELDS, $postParams); // dekodowanie rezultatu w formacie JSON do tablicy result $data = curl_exec($c); $result = (Array)json_decode($data); // sprawdzenie, czy wystąpił błąd if (isset($result['error'])) { echo "Wystąpił błąd: " . $result['error'] . ", kod: " . $result['code']; } else { foreach ($result as $item) { $option = (Array)$item; echo "Id produktu: " . $option['product_id'] . "<br>"; echo "Typ ceny: " . $option['price_type'] . "<br>"; echo "Cena: " . $option['price'] . "<br>"; echo "Stan magazynowy: " . $option['stock'] . "<br>"; // itp. echo "<hr><br>"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>