REST API

Aktualna dokumentacja nowoczesnego interfejsu rest api jest dostępna pod adresem https://developers.shoper.pl/

REST API - dokumentacja interfejsu























product.option.list.create

Tworzy listę wariantów

        array call(string $session_id, "product.option.list.create", array($list))
    

Parametry wejściowe

  • list (array) - lista tablic asocjacyjnych zawierających dane wariantów o strukturze:
    • product_id (int) - identyfikator produktu
    • price (float) - 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)
    • price_wholesale (float) - cena hurtowa 1 lub różnica ceny w stosunku do ceny hurtowej 1 wariantu podstawowego - zawsze dodatnia
    • price_wholesale_type (int) - typ obliczania ceny hurtowej 1 (**0 - brak ustalonej ceny, **1 - nowa cena wariantu, **2 - cena zostanie dodana do ceny podstawowej, **3 - cena zostanie odjęta od ceny podstawowej)
    • price_special (float) - cena hurtowa 2 lub różnica ceny w stosunku do ceny hurtowej 2 wariantu podstawowego - zawsze dodatnia
    • price_special_type (int) - typ obliczania ceny hurtowej 2 (**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
    • code (string) - kod wariantu
    • ean (string) - kod ean wariantu
    • 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
    • calculation_unit_id (int|null) - identufikator jednostki miary dla przeliczania ceny jednostkowej
    • calculation_unit_ratio (float) - współczynnik przeliczania ceny jednostkowej
    • 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
    • warehouses (array) - tablica asocjacyjna, której kluczami są identyfikatory magazynów, a wartością jest stan magazynowy w tym magazynie

Wartość zwracana

  • tablica zawierająca dodatnie identyfikatory dodanych obiektów lub kody błędów: (array)

Uwagi

  • 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 wariantu w formie tablicy, rzucany jest wyjątek **Invalid data container**

Uwagi

  • 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];
    }
}

/**
 * Pobranie błędów
 * 
 * @param resource $c cURL resource handle
 * @param string $session Indentyfikatorr sesji użytkownika
 */
function getError($c, $session){
	$params = Array(
        "method" => "call",
        "params" => Array($session, 'internals.validation.errors', null)
    );
    curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params));
    $result = (Array) json_decode(curl_exec($c));
    return $result;
}

$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) {
    $options = Array( 
        Array(    
            "product_id" => 5,
            "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,
            )
        ),
        Array(    
            "product_id" => 5,
            "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.list.create", Array($options))
    );

    // 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 == 0) {
                echo "Operacja się nie udała" . "<br>";
                $err = getError($c, $session);
                foreach($err as $error){
					echo PHP_EOL.$error;
				}
            } else if ($r == -1) {
                echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji" . "<br>";
                $err = getError($c, $session);
                foreach($err as $error){
					echo PHP_EOL.$error;
				}
            } else if ($r == -2) {
                echo "Operacja się nie udała - zabrakło czasu na zrealizowanie operacji" . "<br>";
            }  else {
                echo "Wariant został dodany, id: " . $r . "<br>";
            }
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>