Strict Standards: Declaration of action_plugin_searchtext::register() should be compatible with DokuWiki_Action_Plugin::register($controller) in /lib/plugins/searchtext/action.php on line 14

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/auth.php on line 313

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/actions.php on line 163
webapi:product.stock [Shop Docs]

Dokumentacja techniczna

Metoda product.stock

Pobiera informacje o domyślnym wariancie produktu

array call(string $session_id, "product.stock", array($id))
Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

  1. id (int) - - identyfikator produktu

Wartość zwracana

  1. (array) - tablica asocjacyjna z informacjami o wariancie.
    Zwracana tablica ma strukturę:
    • ['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) - identyfikator zdjęcia produktu, które przedstawia dany wariant

Rzucane wyjątki SoapFault

  • W przypadku próby pobrania informacji o nieistniejącym produkcie, rzucany jest wyjątek z komunikatem product 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.stock", Array(90)) // id produktu
    );
 
    // 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 {
        echo "Id wariantu: " . $result['stock_id'] . "<br>";
        echo "Cena: " . $result['price'] . "<br>";
        echo "Stan magazynowy: " . $result['stock'] . "<br>";
        // itp.
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>