API

Kundenadressen abrufen

GET/api/crm/v2/clients_addressesv2
operationId: clientsAddresses.default

Autorisierung

api-token + language + role

Abfrageparameter

chain_idinteger

Beispiel: 1

branch_idinteger
phone_format_idinteger

Beispiel: 1

phone_numberstring

Beispiel: 9999999999

downloadstring

Werte:yes

Beispiel: yes

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

phone_numberobject (FilterInput)
valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

downloadobject (FilterButtonDownloadCsv)

Download-Button für die Auswahl: Beim Klicken übergeben Sie download=yes

valuestring

Beispiel: Download

typestringerforderlich

Beispiel: button_download_csv

listarray of object
idintegererforderlich

Beispiel: 1

address_namestringerforderlich

Beispiel: test

typestringerforderlich

Werte:homeworkparentschildrenfriendscountry_househotelother

Beispiel: other

zip_codestring

Beispiel: 680045

line_1string

Beispiel: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Beispiel: example

streetstring

Beispiel: Pobedy street

housestring

Beispiel: 19

buildingstring

Beispiel: 1

entrance_numberstring

Beispiel: 1

entrance_codestring

Beispiel: 11

floorstring

Beispiel: 111

apartmentstring

Beispiel: 111

phone_format_idinteger

Beispiel: 1

phone_numberstring

Beispiel: 9999999999

client_namestring

Beispiel: client name

city_namestring

Beispiel: Khabarovsk

paginationobject (Pagination)
max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false