API

Obtenir les adresses des clients

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

Autorisation

api-token + language + role

Paramètres de requête

chain_idinteger

Exemple: 1

branch_idinteger
phone_format_idinteger

Exemple: 1

phone_numberstring

Exemple: 9999999999

downloadstring

Valeurs:yes

Exemple: yes

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

phone_numberobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

downloadobject (FilterButtonDownloadCsv)

Bouton de téléchargement de la sélection : lors du clic, transmettez download=yes

valuestring

Exemple: Download

typestringobligatoire

Exemple: button_download_csv

listarray of object
idintegerobligatoire

Exemple: 1

address_namestringobligatoire

Exemple: test

typestringobligatoire

Valeurs:homeworkparentschildrenfriendscountry_househotelother

Exemple: other

zip_codestring

Exemple: 680045

line_1string

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

line_2string

Exemple: example

streetstring

Exemple: Pobedy street

housestring

Exemple: 19

buildingstring

Exemple: 1

entrance_numberstring

Exemple: 1

entrance_codestring

Exemple: 11

floorstring

Exemple: 111

apartmentstring

Exemple: 111

phone_format_idinteger

Exemple: 1

phone_numberstring

Exemple: 9999999999

client_namestring

Exemple: client name

city_namestring

Exemple: Khabarovsk

paginationobject (Pagination)
max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false