API

Obtener direcciones de clientes

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

Autorización

api-token + language + role

Parámetros de consulta

chain_idinteger

Ejemplo: 1

branch_idinteger
phone_format_idinteger

Ejemplo: 1

phone_numberstring

Ejemplo: 9999999999

downloadstring

Valores:yes

Ejemplo: yes

Respuestas

OK

object
statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

phone_numberobject (FilterInput)
valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botón para descargar la selección: al hacer clic, envíe download=yes

valuestring

Ejemplo: Download

typestringobligatorio

Ejemplo: button_download_csv

listarray of object
idintegerobligatorio

Ejemplo: 1

address_namestringobligatorio

Ejemplo: test

typestringobligatorio

Valores:homeworkparentschildrenfriendscountry_househotelother

Ejemplo: other

zip_codestring

Ejemplo: 680045

line_1string

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

line_2string

Ejemplo: example

streetstring

Ejemplo: Pobedy street

housestring

Ejemplo: 19

buildingstring

Ejemplo: 1

entrance_numberstring

Ejemplo: 1

entrance_codestring

Ejemplo: 11

floorstring

Ejemplo: 111

apartmentstring

Ejemplo: 111

phone_format_idinteger

Ejemplo: 1

phone_numberstring

Ejemplo: 9999999999

client_namestring

Ejemplo: client name

city_namestring

Ejemplo: Khabarovsk

paginationobject (Pagination)
max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false