Metoda product.list.save
Modyfikuje listę produktów
array call(string $session_id, "product.list.save", array($list, $force = false))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- list (array) - tablica, w której kluczem jest identyfikator produktu, a wartością tablica asocjacyjna z danymi produktu do aktualizacji:
- ['producer_id'] (int) - identyfikator producenta
- ['tax_id'] (int) - identyfikator stawki podatkowej
- ['category_id'] (int) - identyfikator głównej kategorii
- ['unit_id'] (int) - identyfikator jednostki miary
- ['other_price'] (double) - cena produktu w innych sklepach
- ['code'] (string) - kod produktu
- ['pkwiu'] (string) - pkwiu produktu
- ['stock'] (array) - tablica asocjacyjna z informacjami o magazynie wariantu podstawowego:
- ['price'] (double) - cena wariantu podstawowego
- ['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
- ['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
- ['translations'] (array) - tablica asocjacyjna z istniejącymi tłumaczeniami obiektu. Kluczami tablicy są nazwy lokalizacji, a wartościami tablice asocjacyjne informacji o tłumaczeniach:
- ['pl_PL'] (array) - przykładowa tablica z informacjami o tłumaczeniu w lokalizacji pl_PL
- ['name'] (string) - nazwa produktu
- ['short_description'] (string) - krótki opis produktu
- ['description'] (string) - opis produktu
- ['active'] (int[0/1]) - aktywność produktu
- ['seo_title'] (string) - tytuł wyświetlany w tagu <title>
- ['seo_description'] (string) - opis wyświetlany w tagu meta description
- ['seo_keywords'] (string) - opis wyświetlany w tagu meta keywords
- ['order'] (int) - priorytet brany pod uwagę podczas sortowania listy produktów
- ['main_page'] (int[0/1]) - czy produkt został wyróżniony na stronie głównej
- ['main_page_order'] (int) - priorytet brany pod uwagę podczas sortowania listy produktów na stronie głównej
- ['options'] (array) - tablica asocjacyjna, której wartościami są tablice asocjacyjne z danymi wariantu do aktualizacji:
- ['stock_id'] (int) - identyfikator wariantu do aktualizacji
- ['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
- ['attributes'] (array) - tablica asocjacyjna, której kluczami są identyfikatory atrybutów a wartościami, ustawiane wartości atrybutu dla produktu
- force (boolean) - czy wymusić modyfikację obiektu mimo istniejącej blokady innego administratora
Wartość zwracana
- (array) - 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
- -2 - operacja się nie udała - zabrakło czasu na zrealizowanie operacji
Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość -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.
Rzucane wyjątki SoapFault
- W przypadku nie podania danych w formie tablicy, rzucany jest wyjątek
- W przypadku podania nieprawidłowej lokalizacji przy tłumaczeniach, 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) { $product1 = Array( "producer_id" => null, "tax_id" => 1, "category_id" => 9, "unit_id" => 2, "other_price" => 9.50, "code" => md5(rand()), "pkwiu" => null, "stock" => Array( "price" => 8.99, "stock" => 10, "warn_level" => 2, "sold" => 0, "weight" => 1.2, "availability_id" => null, "delivery_id" => null, "gfx_id" => null, ), "translations" => Array( "pl_PL" => Array( "name" => "Aktualizacja produktu 1", "short_description" => "Aktualizacja produktu 1", "description" => "Aktualizacja produktu 1", "active" => 1, "seo_title" => "", "seo_description" => "", "seo_keywords" => "produkt1, test, api", "order" => null, "main_page" => 0, "main_page_order" => null, ), ), ); $product2 = Array( "producer_id" => null, "tax_id" => 1, "category_id" => 9, "unit_id" => 2, "other_price" => 9.50, "code" => md5(rand()), "pkwiu" => null, "stock" => Array( "price" => 8.99, "stock" => 10, "warn_level" => 2, "sold" => 0, "weight" => 1.2, "availability_id" => null, "delivery_id" => null, "gfx_id" => null, ), "translations" => Array( "pl_PL" => Array( "name" => "Aktualizacja produktu 2", "short_description" => "Aktualizacja produktu 2", "description" => "Aktualizacja produktu 2", "active" => 1, "seo_title" => "", "seo_description" => "", "seo_keywords" => "produkt2, test, api", "order" => null, "main_page" => 0, "main_page_order" => null, ), ), ); $products = Array( 5 => $product1, 6 => $product2 ); $params = Array( "method" => "call", "params" => Array($session, "product.list.save", Array($products, true)) ); // 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 $r) { if ($r == -2) { echo "Operacja się nie udała - zabrakło czasu na zrealizowanie operacji<br>"; } else if ($r == -1) { echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji<br>"; } else if ($r == 0) { echo "Operacja się nie udała<br>"; } else if ($r == 1) { echo "Produkt został zapisany<br>"; } else if ($r == 2) { echo "Operacja się nie udała - obiekt jest zablokowany przez innego administratora<br>"; } } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>