Metoda product.create
Dodaje produkt
array call(string $session_id, "product.create", array($data))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
- ['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) - wymagana 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) - wymagana 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
- ['attributes'] (array) - tablica asocjacyjna, której kluczami są identyfikatory atrybutów a wartościami, ustawiane wartości atrybutu dla produktu
Wartość zwracana
- (int) - dodatni identyfikator dodanego obiektu lub kod błędu:
- 0 - operacja się nie udała
- -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) { $product = 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" => "Produkt testowy", "short_description" => "Krótki opis", "description" => "Opis produktu testowego", "active" => 1, "seo_title" => "Produkt testowy", "seo_description" => "Opis produktu testowego", "seo_keywords" => "produkt, test, api", "order" => null, "main_page" => 0, "main_page_order" => null, ), ), "options" => Array( // warianty 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_wariantu => id_wartości 1 => 5, ), ), Array( "price" => 1.55, "price_type" => 2, // dodanie ceny "stock" => 8, "warn_level" => 3, "weight" => 1.4, "weight_type" => 1, // nowa waga "active" => 1, "default" => 0, "availability_id" => null, "delivery_id" => null, "gfx_id" => null, "options" => Array( // id_wariantu => id_wartości 1 => 6, ), ), // itp. ), ); $params = Array( "method" => "call", "params" => Array($session, "product.create", Array($product)) ); // 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] == 0) { echo "Operacja się nie udała"; } else if ($result[0] == -1) { echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji"; } else { echo "Produkt został dodany, id: " . $result[0]; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>