API

Ottenere gli indirizzi dei clienti

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

Autorizzazione

api-token + language + role

Parametri della richiesta

chain_idinteger

Esempio: 1

branch_idinteger
phone_format_idinteger

Esempio: 1

phone_numberstring

Esempio: 9999999999

downloadstring

Valori:yes

Esempio: yes

Risposte

OK

object
statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

phone_numberobject (FilterInput)
valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

downloadobject (FilterButtonDownloadCsv)

Pulsante di download della selezione: al clic, passa download=yes

valuestring

Esempio: Download

typestringobbligatorio

Esempio: button_download_csv

listarray of object
idintegerobbligatorio

Esempio: 1

address_namestringobbligatorio

Esempio: test

typestringobbligatorio

Valori:homeworkparentschildrenfriendscountry_househotelother

Esempio: other

zip_codestring

Esempio: 680045

line_1string

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

line_2string

Esempio: example

streetstring

Esempio: Pobedy street

housestring

Esempio: 19

buildingstring

Esempio: 1

entrance_numberstring

Esempio: 1

entrance_codestring

Esempio: 11

floorstring

Esempio: 111

apartmentstring

Esempio: 111

phone_format_idinteger

Esempio: 1

phone_numberstring

Esempio: 9999999999

client_namestring

Esempio: client name

city_namestring

Esempio: Khabarovsk

paginationobject (Pagination)
max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false