REST API

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

REST API - dokumentacja interfejsu























subscriber.list.save

Aktualizuje listę subskrybentów

        array call(string $session_id, "subscriber.list.save", array($list, $force = false))
    

Parametry wejściowe

  • list (array) - tablica asocjacyjna z danymi obiektu o strukturze:
    • email (string) - Adres e-mail
    • active (0|1) - czy subskrybent jest aktywny
    • lang_id (int) - Wybrany język
    • groups (array) - Lista ID grup, do których przypisać rekord. Jeśli brak, zostanie przyjęta grupa domyślna.
  • force (boolean) - czy wymusić aktualizację obiektu mimo istniejącej blokady innego administratora

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)