Metoda shipping.list
Pobiera listę metod dostaw
array call(string $session_id, "shipping.list", array($extended = false, $ranges = false, $payments = false, $shippings = ""))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- extended (bool) - - czy zwrócić tylko listę identyfikatorów metod dostaw (false), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (true)
- ranges (boolean) - - czy zwrócić dodatkowo informacje o przedziałach wagowych/cenowych
- payments (boolean) - - czy zwrócić dodatkowo informacje o dowiązanych metodach płatności
- shippings
Wartość zwracana
- (array) - jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów.
- (array) - jeśli parametr extended ustawiony jest na true, zwracana jest tablica (wektor) o długości tablicy podanej jako czwarty parametr metody. Wektor składa się z tablic asocjacyjnych o strukturze:
- ['shipping_id'] (int) - identyfikator metody dostawy
- ['name'] (string) - nazwa metody dostawy
- ['url'] (string) - adres url śledzenia paczki
- ['description'] (string) - opis metody dostawy
- ['cost'] (double) - ustalona stała cena dostawy lub 0, jeśli cena dostawy jest zalezna od wagi lub wartości zamówienia
- ['lang_id'] (int) - identyfikator lokalizacji
- ['depend_on_w'] (int[0/1/2]) - czy metoda dostawy jest zalezna od wartości zamówienia (2), czy od wagi (1), lub 0 jeśli metoda dostawy nie zależy od powyższych parametrów
- ['tax_id'] (int) - identyfikator stawki podatkowej
- ['max_weight'] (float) - maksymalna waga zamówionych produktów, jaką obsługuje metoda dostawy
- ['free_shipping'] (float) - darmowa dostawa od podanej kwoty lub 0 w przypadku braku opcji darmowej dostawy
- ['order'] (int) - priorytet brany pod uwagę przy szacowaniu kolejności wyświetlania metod dostawy
- ['lang_id'] (int) - identyfikator lokalizacji
- ['is_default'] (int[0/1]) - czy dostawa jest domyślną metodą dostawy
- ['pkwiu'] (string) - PKWiU od metody dostawy
- ['max_cost'] (double) - maksymalna wartość zamówienia obsługiwana przez tą metodę dostawy lub 0 w przypadku braku ograniczeń
- ['active'] (int[0/1]) - czy dostawa jest aktywna
- ['ranges'] (array) - tablica (wektor) składający się z tablic asocjacyjnych informacji o przedziałach wagowych/cenowych, zwracana tylko wtedy, kiedy parametr $ranges jest ustawiony na true. Tablice mają strukturę:
- ['weight_id'] (int) - identyfikator przedziału
- ['shipping_id'] (int) - identyfikator metody dostawy
- ['from'] (double) - początek przedziału
- ['to'] (double) - koniec przedziału (wartość 0 oznacza dodatnią nieskończoność)
- ['price'] (double) - cena dostawy w danym przedziale
- ['payments'] (array) - tablica, której wartościami są identyfikatory metod płatności dowiązanych do dostawy, zwracana tylko wtedy, kiedy parametr $payments jest ustawiony na true
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 próby pobrania informacji o nieistniejąej metodzie dostawy, rzucany jest wyjątek z komunikatem shipping 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, "shipping.list", Array(true, true, true, // extended, ranges, payments Array(1, 7) // id dostaw ) ) ); // 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) { $shipping = (Array)$item; echo "Id metody dostawy: " . $shipping['shipping_id'] . "<br>"; echo "Nazwa: " . $shipping['name'] . "<br>"; // itp. echo "<br>Przedziały wagowe/cenowe:<br>"; $ranges = (Array)$shipping['ranges']; foreach ($ranges as $r) { $range = (Array)$r; echo "Od: " . $range['from'] . ", "; echo "do: " . $range['to'] . ", "; echo "cena: " . $range['price'] . "<br>"; // itp. } echo "<br>Płatności:<br>"; $payments = (Array)$shipping['payments']; foreach ($payments as $paymentId) { echo "Id płatności: " . $paymentId . "<br>"; } echo "<hr><br>"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>