REST API

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

REST API - dokumentacja interfejsu























parcel.list.create

Tworzy listę paczek

        array call(string $session_id, "parcel.list.create", array($data))
    

Parametry wejściowe

  • data (array) - Tablica (wektor) zawierająca tablice z danymi paczki o strukturze:
    • order_id () - (int) - Identyfikator zamówienia
    • shipping_id () - (int) - Identifikator dostawcy zamówienia
    • shipping_code () - (string) - Numer listu przewozowego
    • weight () - (float) - Waga paczki
    • insurance () - (int[0/1]) - Czy paczka jest ubezpieczona?
    • insurance_cost () - (float) - Kwota ubezpieczenia
    • cod () - (int[0/1]) - Czy paczka jest przesyłką pobraniową?
    • cod_cost () - (float) - Kwota pobrania
    • notes () - (string) - Komentarz
    • online () - (int[0/1]) - Czy stan wysyłki paczki jest obsługiwany przez zewnętrzną integrację?
    • products () - (null|array)- Tablica (wektor) składająca się z tablic asocjacyjnych produktów z zamówienia do umieszczenia w paczce. W przypadku braku, zostaną dodane wszystkie przedmioty. Struktura:
      • 0 () - (array) - Przykładowa tablica zawierająca dane poszczególnego produktu w formacie:
        • order_product_id (int) - Identyfikator dodawanego produktu
        • quantity () - (float) - Ilość danego produktu

Wartość zwracana

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 obiektu w formie tablicy, rzucany jest wyjątek **Invalid data container**
  • W przypadku braku dostępu do dodawania dla modułu 'sprzedaż', wyrzucany jest wyjątek z komunikatem **Access denied**

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)