REST API

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

REST API - dokumentacja interfejsu























user.address.list.save

Aktualizuje listę adresów użytkownika

        array call(string $session_id, "user.address.list.save", array($list, $force = false, $userId = null))
    

Parametry wejściowe

  • list (array) - tablica w formacie [id_uzytkownika] => [dane]
    • (0-9)+ (-) - tablica asocjacyjna z danymi obiektu o strukturze:
      • company_name (string) - (opcjonalne) - nazwa firmy
      • tax_id (string) - (opcjonalne) - NIP
      • firstname (string) - (opcjonalne) - imię
      • lastname (string) - (opcjonalne) - nazwisko
      • street_1 (string) - (opcjonalne) - adres
      • street_2 (string) - (opcjonalne) - adres c.d
      • city (string|int) - (opcjonalne) - miasto
      • zip_code (string) - (opcjonalne) - kod pocztowy
      • state (string|int) - (opcjonalne) - województwo
      • country_code (string) - (opcjonalne) - kod kraju - ISO 3166-2
      • country (string|int) - (opcjonalne) - kraj
      • pesel (string) - (opcjonalne) - PESEL - brane pod uwagę jeśli opcja Konfiguracja -> Sprzedaż -> Zakupy -> "Włącz obsługę numeru PESEL dla osób fizycznych" jest aktywna
      • phone (string) - (opcjonalne) - numer telefonu
      • default (int) - (opcjonalny) - domyślny dla płatności - 0|1
      • shipping_default (int) - (opcjonalny) - domyślny dla wysyłki - 0|1
  • force (boolean) - czy wymusić aktualizację obiektu mimo istniejącej blokady innego administratora
  • userId

Wartość zwracana

  • tablica zawierająca dodatnie identyfikatory dodanych obiektów lub kody błędów: (array)

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

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)