API

Obter endereços dos clientes

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

Autorização

api-token + language + role

Parâmetros de consulta

chain_idinteger

Exemplo: 1

branch_idinteger
phone_format_idinteger

Exemplo: 1

phone_numberstring

Exemplo: 9999999999

downloadstring

Valores:yes

Exemplo: yes

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

phone_numberobject (FilterInput)
valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botão de download da seleção: ao clicar, envie download=yes

valuestring

Exemplo: Download

typestringobrigatório

Exemplo: button_download_csv

listarray of object
idintegerobrigatório

Exemplo: 1

address_namestringobrigatório

Exemplo: test

typestringobrigatório

Valores:homeworkparentschildrenfriendscountry_househotelother

Exemplo: other

zip_codestring

Exemplo: 680045

line_1string

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

line_2string

Exemplo: example

streetstring

Exemplo: Pobedy street

housestring

Exemplo: 19

buildingstring

Exemplo: 1

entrance_numberstring

Exemplo: 1

entrance_codestring

Exemplo: 11

floorstring

Exemplo: 111

apartmentstring

Exemplo: 111

phone_format_idinteger

Exemplo: 1

phone_numberstring

Exemplo: 9999999999

client_namestring

Exemplo: client name

city_namestring

Exemplo: Khabarovsk

paginationobject (Pagination)
max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false