REST API

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

REST API - dokumentacja interfejsu























parcel.list

Zwraca informacje o paczkach w systemie

        array call(string $session_id, "parcel.list", array($extended = false, $addresses = false, $parcels = null))
    

Parametry wejściowe

  • extended
  • addresses
  • parcels

Wartość zwracana

  • $data jeśli parametr **extended** ustawiony jest na **false**, zwracana jest tablica z identyfikatorami dostępnych obiektów. (array)
  • $data jeśli parametr **extended** ustawiony jest na **true**, zwracana jest tablica (wektor). Wektor składa się z tablic asocjacyjnych o strukturze: (array)

Uwagi

  • 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 braku dostępu do odczytu dla modułu 'sprzedaż', wyrzucany jest wyjątek z komunikatem **Access denied**
  • W przypadku próby pobrania informacji o nieistniejącej paczce, wyrzucany jest wyjątek z komunikatem **Object 'parcel' identified as id: '{$id}' does not exist**

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)