REST API

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

REST API - dokumentacja interfejsu























order.info

Pobiera informacje o zamówieniu

        array call(string $session_id, "order.info", array($id, $products = false, $billingAddress = "1", $deliveryAddress = "1", $auction = "1", $additionalFields = false, $shippingAdditionalFields = false, $paymentAdditionalFields = false))
    

Parametry wejściowe

  • id (int) - identyfikator zamówienia
  • products (boolean) - czy pobrać informacje o produktach (domyślnie false)
  • billingAddress (boolean) - czy pobrać informacje o adresie do faktury (domyślnie true)
  • deliveryAddress (boolean) - czy pobrać informacje o adresie do dostawy (domyślnie true)
  • auction (boolean) - czy pobrać informacje o aukcji (domyślnie true)
  • additionalFields (boolean) - czy pobrać dodatkowe informacje z zamówienia (domyślnie false)
  • shippingAdditionalFields (boolean) - czy pobrać dodatkowe informacje o dostawie (tylko dla typów zintegrowanych - domyślnie false)
  • paymentAdditionalFields (boolean) - czy pobrać dodatkowe informacje o płatności (tylko dla typów zintegrowanych - domyślnie false)

Wartość zwracana

  • tablica asocjacyjna z informacjami o zamówieniu. \\ Zwracana tablica ma strukturę: (array)

Rzucane wyjątki SoapFault

  • W przypadku próby pobranie informacji o nieistniejącym zamówieniu, wyrzucany jest wyjątek z komunikatem **Object 'order' identified as id: '{$id}' does not exist**
  • W przypadku próby pobrania złączonego wcześniej zamówienia wyrzucany jest wyjątek z komunikatem **Wykryto złączone zamówienie**

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) {
    $params = Array(
        "method" => "call",
        "params" => Array($session, "order.info", 
                Array(2, true) // id zamówienia, produkty
            )
    );

    // 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 zamówienia: " . $result['order_id'] . "<br>";
        echo "Wartość zamówienia: " . $result['sum'] . "<br>";
        echo "Data złożenia: " . $result['date'] . "<br>";
        // itp.
        
        echo "<br>Adres bilingowy:<br>";
        $billingAddress = (Array)$result['billingAddress'];
        echo "Imię: " . $billingAddress['firstname'] . "<br>";
        echo "Nazwisko: " . $billingAddress['lastname'] . "<br>";
        echo "Miejscowość: " . $billingAddress['city'] . "<br>";
        echo "Adres (linia 1): " . $billingAddress['street1'] . "<br>";
        echo "Adres (linia 2): " . $billingAddress['street2'] . "<br>";
        // itp.
        
        echo "<br>Adres dostawy:<br>";
        $deliveryAddress = (Array)$result['billingAddress'];
        echo "Imię: " . $deliveryAddress['firstname'] . "<br>";
        echo "Nazwisko: " . $deliveryAddress['lastname'] . "<br>";
        echo "Miejscowość: " . $deliveryAddress['city'] . "<br>";
        echo "Adres (linia 1): " . $deliveryAddress['street1'] . "<br>";
        echo "Adres (linia 2): " . $deliveryAddress['street2'] . "<br>";
        // itp.
        
        echo "<br>Produkty:<br>";
        $products = (Array)$result['products'];
        foreach ($products as $p) {
            $product = (Array)$p;
            echo "Nazwa: " . $product['name'] . "<br>";
            echo "Kod: " . $product['code'] . "<br>";
            echo "Wariant: " . $product['option'] . "<br>";
            // itp.
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}

curl_close($c);
?>