REST API

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

REST API - dokumentacja interfejsu























order.product.save

Aktualizuje produkt z zamówienia

        array call(string $session_id, "order.product.save", array($id, $data, $force = false))
    

Parametry wejściowe

  • id (int) - identyfikator
  • data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
    • price (float) - (opcjonalne) cena produktu
    • discount_perc (float) - (opcjonalne) zniżka procentowa
    • quantity (float) - (opcjonalne) ilość
    • delivery_time (float) - (opcjonalne) czas dostawy w dniach
    • name (string[0,255]) - (opcjonalne) nazwa produktu
    • code (string[0,100]) - (opcjonalne) kod produktu
    • pkwiu (string[0,20]) - (opcjonalne) PKWIU
    • tax (int) - (opcjonalne) wartość stawki podatkowej
    • unit_id (int) - (opcjonalne) identyfikator jednostki - w przypadku nieprzekazania danego parametru należy uzupełnić pola unit oraz unit_fp
    • unit (string[0,50]) - (opcjonalne) jednostka miary
    • unit_fp (int[0/1]) - (opcjonalne) flaga, czy jednostkia miary jest zmiennoprzecinkowa
    • option (string) - (opcjonalne) nazwa wariantu produktu -
    • weight (double) - (opcjonalne) waga
  • force (boolean) - czy wymusić aktualizację obiektu mimo istniejącej blokady innego administratora

Wartość zwracana

  • status operacji: (int)

Rzucane wyjątki SoapFault

  • W przypadku nie podania danych klienta w formie tablicy, rzucany jest wyjątek **Invalid data container**
  • W przypadku braku dostępu do edycji dla modułu 'sprzedaż', wyrzucany jest wyjątek z komunikatem **Access denied**
  • W przypadku podania nieistniejącego produktu w zamówieniu, wyrzucany jest wyjątek z komunikatem **Object 'orderProduct' 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)