REST API

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

REST API - dokumentacja interfejsu























user.save

Aktualizuje użytkownika

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

Parametry wejściowe

  • id (int) - identyfikator
  • data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
    • email (string) - email użytkownika
    • password (string) - hasło użytkownika
    • firstname (string) - imię użytkownika
    • lastname (string) - nazwisko użytkownika
    • discount (float) - rabat indywidualny % - <0, 99.99>
    • active (int) - aktywność - 0|1
    • group_id (int) - identyfikator grupy
    • verify_email (int) - czy email użytkownika jest zweryfikowany - 0|1
    • comment (string) - uwagi
    • addresses (array) - tablica w formacie [id_adresu] => [dane]
      • (0-9)+ () - tablica asocjacyjna z danymi obiektu o strukturze:
        • company_name (string) - nazwa firmy
        • tax_id (string) - NIP
        • firstname (string) - imię
        • lastname (string) - nazwisko
        • street_1 (string) - adres
        • street_2 (string) - adres c.d
        • city (string|int) - miasto
        • zip_code (string) - kod pocztowy
        • state (string|int) - województwo
        • country_code (string) - kod kraju - ISO 3166-2
        • country (string|int) - kraj
        • pesel (string) - PESEL - brane pod uwagę jeśli opcja Konfiguracja -> Sprzedaż -> Zakupy -> "Włącz obsługę numeru PESEL dla osób fizycznych" jest aktywna
        • phone (string) - numer telefonu
        • default (int) - domyślny dla płatności - 0|1 - w przypadku podania pojedyńczego adresu ustawiany jest na 1
        • shipping_default (int) - (opcjonalny) - domyślny dla wysyłki - 0|1 - w przypadku podania pojedyńczego adresu ustawiany jest na 1
    • additional_fields () - pola dodatkowe
      • 0-9+) (int|string) - identyfikator pola dodatkowego => wartość:
        • 0|1) () -
        • ----> dla "pola tekstowego" (string) -
        • ----> dla "pola wyboru" (string) - nazwa pola wyboru
  • 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 'klienci', wyrzucany jest wyjątek z komunikatem **Access denied**
  • W przypadku podania nieistniejącego użytkownika, wyrzucany jest wyjątek z komunikatem **Object 'user' 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)