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.list [Shop Docs]

Dokumentacja techniczna

Jesteś tutaj: Dokumentacja Sklepu » webapi » product.list

Metoda product.list

Pobiera listę produktów

array call(string $session_id, "product.list", array($extended = false, $translations = false, $options = false, $gfx = false, $attributes = false, $products = ""))
Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

  1. extended (boolean) - czy zwrócić informacje o obiektach
  2. translations (boolean) - czy zwrocić dodatkowo informacje o tłumaczeniach
  3. options (boolean) - czy zwrócić dodatkowo informacje o wariantach
  4. gfx (boolean) - czy zwrócić dodatkowo informacje o zdjęciach
  5. attributes (boolean) - czy zwrócić dodatkowo informacje o atrybutach
  6. products (array|null) - tablica identyfikatorów obiektów do pobrania lub null w celu pobrania wszystkich dostępnych obiektów

Wartość zwracana

  1. (array) - $data jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów. :
  2. (array) - $data jeśli parametr extended ustawiony jest na true, zwracana jest tablica (wektor) o długości tablicy podanej jako ostatni parametr metody. Wektor składa się z tablic asocjacyjnych o strukturze:
    • ['product_id'] (int) - identyfikator produktu
    • ['producer_id'] (int) - identyfikator producenta
    • ['group_id'] (int) - identyfikator grupy cech, do której przypisany jest produkt
    • ['tax_id'] (int) - identyfikator stawki podatkowej
    • ['category_id'] (int) - identyfikator głównej kategorii
    • ['unit_id'] (int) - identyfikator jednostki miary
    • ['add_date'] (string) - data dodania produktu w formacie RRRR-MM-DD hh:mm:ss
    • ['edit_date'] (string) - data ostatniej modyfikacji produktu w formacie RRRR-MM-DD hh:mm:ss
    • ['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:
      • ['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). Zawsze 0.
      • ['price'] (double) - cena wariantu podstawowego
      • ['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). Zawsze 1.
      • ['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
    • ['translations'] (array) - tablica asocjacyjna z istniejącymi tłumaczeniami obiektu, zwracana tylko wtedy, kiedy parametr $translations jest ustawiony na true. 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
        • ['translation_id'] (int) - identyfikator tłumaczenia
        • ['product_id'] (int) - identyfikator produktu
        • ['name'] (string) - nazwa produktu
        • ['short_description'] (string) - krótki opis produktu
        • ['description'] (string) - opis produktu
        • ['active'] (int[0/1]) - aktywność produktu
        • ['isdefault'] (int[0/1]) - czy produkt został dostarczony wraz z instalacją sklepu
        • ['lang_id'] (int) - identyfikator lokalizacji
        • ['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 (wektor) identyfikatorów wariantów dodatkowych podanego produktu, zwracana tylko wtedy, kiedy parametr $options jest ustawiony na true.
    • ['images'] (array) - tablica (wektor) z informacjami o zdjęciach produktu, zwracana tylko wtedy, kiedy parametr $gfx jest ustawiony na true. Wektor składa się z tablic asocjacyjnych o strukturze:
      • ['gfx_id'] (int) - identyfikator zdjęcia
      • ['product_id'] (int) - identyfikator produktu
      • ['main'] (int[0/1]) - czy zdjęcie jest zdjęciem głównym
      • ['order'] (int) - kolejność zdjęcia
      • ['name'] (string) - opis zdjęcia
      • ['unic_name'] (string) - unikalna nazwa zdjęcia, określająca nazwę pliku w systemie
    • ['attributes'] (array) - tablica asocjacyjna zwracana tylko wtedy, kiedy parametr $attributes jest ustawiony na true. Kluczami w tablicy są identyfikatoty grup atrybutow, a wartościami tablice asocjacyjne, których kluczami są identyfikatory atrybutów, a wartościami aktualne wartości atrybutów dla danego produktu.
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 podania identyfikatora nieistniejącego obiektu, 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) {
    $params = Array(
        "method" => "call",
        "params" => Array($session, "product.list", 
                Array(true, true, true, true, true, 
                        Array(59, 91, 92, 93, 94) // id produktó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) {
            $product = (Array)$item;
 
            echo "Id: " . $product['product_id'] . "<br>";
 
            $translations = (Array)$product['translations'];
            $translPL = (Array)$translations['pl_PL'];
            echo "Nazwa w języku polskim: " . $translPL['name'] . "<br>";
 
            $stock = (Array)$product['stock'];
            echo "Cena: " . $stock['price'] . "<br>";
            echo "Stan magazynowy: " . $stock['stock'] . "<br>";
 
            $gfx = (Array)$product['images'];
            foreach ($gfx as $g) {
                $image = (Array)$g;
                echo "Id zdjęcia: " . $image['gfx_id'] . "<br>";
            }
 
            $attributes = (Array)$product['attributes'];
            foreach ($attributes as $attGId => $attG) {
                echo "Id grupy atrybutów: " . $attGId . "<br>";
                $attGroup = (Array)$attG;
                foreach ($attGroup as $attVId => $attV) {
                    echo " - id atrybutu: " . $attVId . ", wartość: " . $attV . "<br>";
                }
            }
 
            echo "<hr><br>";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>