Контрагент
Список контрагентов
GET
https://api.livesklad.com/counteragents
Возвращает массив контрагентов
Для сортировки результата необходимо в параметре sort передать строку "<название_поля> ASC" или "<название_поля> DESC". Где ASC - сортировать по возрастанию, DESC - сортировать по убыванию, <название_поля> - поле по которому осуществляется сортировка, может быть одно из: id, typeCounteragent, lastAction, name, howKnow, node, address, email, phones. По умолчанию контрагенты сортируются по имени Фильтры по датам передаются в виде массива из двух чисел в формате Unix (в миллисекундах), где первый число - это начало диапазона, а второе - конец диапазона. Если какая-то граница диапазона отсутствует, то вместо нее нужно передать null. Например [1690837200000,1693515599999] или [null,1693515599999]
Из списка с любым заданным набором фильтров можно получить максимум 10000 элементов, то есть максимальное значение для page * pageSize = 10000. Чтобы получить другие элементы, нужно либо изменить фильтр, либо изменить сортировку
Query Parameters
dateCreate
array
Фильтр по дате создания
sort
string
Сортировка
filter
string
Текст для поиска по контрагентам
lastAction
array
Фильтр по дате последнего изменения
phone
string
Телефон для поиска
page
number
Номер страницы выборки (по умолчанию - 1)
pageSize
number
Количество элементов в выборке (по умолчанию - 10, максимум - 50)
isBuyer
boolean
Фильтр: "Только покупатели"
isVendor
boolean
Фильтр: "Только поставщики"
howKnowIds
array
Фильтр по источникам рекламы, передается в виде массива id источников рекламы
typeCounteragentId
Фильтр по типу контрагента
Headers
Authorization*
String
Токен авторизации
Создание контрагента
POST
https://api.livesklad.com/counteragents
Создает контрагента и возвращает созданную запись
Headers
Authorization*
string
Токен авторизации
Request Body
name*
string
Имя контрагента
typeCounteragentId*
string
id типа контрагента
isBuyer*
boolean
Контрагент является покупателем
isVendor*
boolean
Контрагент является поставщиком
string
email контрагента
howKnowId
string
id источника рекламы контрагента
address
string
Адрес контрагента
phones
array
Телефоны контрагента, передается в виде массива строк
node
string
Примечание
isSendSms
boolean
Контрагенту можно отправлять смс-сообщения (по умолчанию - false)
rating
number
Рейтинг контрагента (обычный: 0, негативный клиент: -1, позитивный: 1)
customFields
array
Массив пользовательских полей
isSendTelegram
boolean
Контрагенту можно отправлять сообщения в Telegram (по умолчанию - false)
isSendEmail
boolean
Контрагенту можно отправлять письма на email (по умолчанию - false)
Изменение контрагента
PATCH
https://api.livesklad.com/counteragents/{id}
Изменяет информацию в карточке контрагента
Headers
Authorization*
string
Токен авторизации
Request Body
name
string
Имя контрагента
isSendSms
boolean
Контрагенту можно отправлять смс-сообщения
node
string
Примечание
phones
array
Телефоны контрагента, передаются в виде массива строк
address
string
Адрес контрагента
howKnowId
string
id источника рекламы
string
email контрагента
isVendor
boolean
Контрагент является поставщиком
isBuyer
boolean
Контрагент является покупателем
typeCounteragentId
string
id типа контрагента
isSendEmail
boolean
Контрагенту можно отправлять письма на email
isSendTelegram
boolean
Контрагенту можно отправлять сообщения в Telegram
rating
number
Рейтинг контрагента (обычный: 0, негативный клиент: -1, позитивный: 1)
customFields
array
Массив пользовательских полей
customFields передается в формате:
По умолчанию обязательными являются только поля name, typeCounteragentId, isBuyer, isVendor. Но в случае если для указанного типа контрагента (определяется по typeCounteragentId) изменена форма контрагента, то обязательными могут быть так же и другие поля
Список типов контрагентов
GET
https://api.livesklad.com/type-counteragents
Возвращает массив типов контрагентов
Headers
Authorization*
string
Токен авторизации
Список пользовательских полей для типа контрагента
GET
https://api.livesklad.com/type-counteragents/{id}/fields
Возвращает массив пользовательских полей для типа контрагента
Path Parameters
id*
string
id типа контрагента
Headers
Authorization*
string
Токен авторизации
Информация о контрагенте
GET
https://api.livesklad.com/counteragents/{id}
Возвращает полную информацию о контрагенте
Path Parameters
id*
string
id контрагента
Headers
Authorization*
string
Токен авторизации
Last updated