Metoda product.option.save
Modyfikuje wariant produktu
array call(string $session_id, "product.option.save", array($id, $data, $force = false))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- id (int) - identyfikator obiektu
- data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
- ['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
- ['stock_relative'] (float) - różnica stanu magazynowego o jaką ma zostać zaktualizowa wartość w sklepie. Jeśli ten parametr występuje, parametr 'stock' nie jest brany pod uwagę podczas aktualizacji danych.
- ['warn_level'] (float) - alarm magazynowy
- ['sold'] (float) - ilość sprzedanego towaru
- ['sold_relative'] (float) - różnica ilości sprzedanego towaru o jaką ma zostać zaktualizowa wartość w sklepie. Jeśli ten parametr występuje, parametr 'sold' nie jest brany pod uwagę podczas aktualizacji danych.
- ['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) - 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
- force (boolean) - czy wymusić modyfikację obiektu mimo istniejącej blokady innego administratora
Wartość zwracana
- (int) - status operacji:
- 0 - operacja się nie udała
- 1 - operacja się udała
- 2 - operacja się nie udała - obiekt jest zablokowany przez innego administratora
- -1 - podane dane są nieprawidłowe i nie spełniają wymagań walidacji
Rzucane wyjątki SoapFault
- W przypadku nie podania danych w formie tablicy, rzucany jest wyjątek
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) { $option = Array( "price" => 1.50, "price_type" => 2, // dodanie ceny "stock" => 9, "warn_level" => 2, "weight" => 1.3, "weight_type" => 1, // nowa waga "active" => 1, "default" => 0, "availability_id" => null, "delivery_id" => null, "gfx_id" => null, "options" => Array( // id cechy => id wartości 1 => 5, ), ); $params = Array( "method" => "call", "params" => Array($session, "product.option.save", Array(138, $option, true) // id wariantu, wariant, force ) ); // 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 { if ($result[0] == -1) { echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji"; } else if ($result[0] == 0) { echo "Operacja się nie udała"; } else if ($result[0] == 1) { echo "Operacja się udała"; } else if ($result[0] == 2) { echo "Operacja się nie udała - obiekt jest zablokowany przez innego administratora"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>