REST API

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

REST API - dokumentacja interfejsu























user.address.create

Tworzy adres dla użytkownika

        array call(string $session_id, "user.address.create", array($id, $data))
    

Parametry wejściowe

  • id (int) - (wymagane) identyfikator użytkownika
  • data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
    • company_name (string) - (opcjonalne) - nazwa firmy
    • tax_id (string) - (opcjonalne) - NIP
    • firstname (string) - (wymagane) - imię
    • lastname (string) - (wymagane) - nazwisko
    • street_1 (string) - (wymagane) - adres
    • street_2 (string) - (opcjonalne) - adres c.d
    • city (string|int) - (wymagane) - miasto
    • zip_code (string) - (wymagane) - 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) - (wymagane) - numer telefonu
    • default (int) - (opcjonalny) - domyślny dla płatności - 0|1
    • shipping_default (int) - (opcjonalny) - domyślny dla wysyłki - 0|1

Wartość zwracana

  • dodatni identyfikator dodanego obiektu lub kod błędu: (int)

Rzucane wyjątki SoapFault

  • W przypadku podania nieistniejącego użytkownika, wyrzucany jest wyjątek z komunikatem **Object 'user' identified as id: '{$id}' does not exist**
  • W przypadku nie podania danych producenta w formie tablicy, rzucany jest wyjątek **Invalid data container**
  • W przypadku braku dostępu do dodawania dla modułu 'klienci', 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)