Заказы
Список заказов в мастерской
GET
https://api.livesklad.com/shops/{id}/orders
Возвращает массив заказов для мастерской. Для получения списка заказов у API должен быть настроен доступ к заказам и доступ к соответствующей мастерской Для сортировки результата необходимо в параметре sort передать строку "<название_поля> ASC" или "<название_поля> DESC". Где ASC - сортировать по возрастанию, DESC - сортировать по убыванию, <название_поля> - поле по которому осуществляется сортировка, может быть одно из: id, sn, typeOrder, manager, closeManager, master, brand, model, typeDevice, node, problem, completeSet, number, num, dateCreate, lastAction, dateClose, dateFinish, deadline, statusDeadline, counteragent, address, summ, cash, status, isUrgent. По умолчанию заказы сортируются от новых к старым Фильтры по датам передаются в виде массива из двух чисел в формате Unix (в миллисекундах), где первый число - это начало диапазона, а второе - конец диапазона. Если какая-то граница диапазона отсутствует, то вместо нее нужно передать null. Например [1690837200000,1693515599999] или [null,1693515599999]
Из списка с любым заданным набором фильтров можно получить максимум 10000 элементов, то есть максимальное значение для page * pageSize = 10000. Чтобы получить другие элементы, нужно либо изменить фильтр, либо изменить сортировку
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | id мастерской |
Query Parameters
Name | Type | Description |
---|---|---|
isVisible | boolean | Фильтр по удаленным заказам. Если true - будут считаны только не удаленные заказы, если false - будут считаны только удаленные заказы, если параметр не отсутствует - будут считаны все заказы |
sort | string | Сортировка |
statusIds | array | Фильтр по статусам заказов, передается в виде массива id статусов |
masterId | string | Фильтр по мастеру которому назначен заказ |
managerId | string | Фильтр по менеджеру которому назначен заказ |
counteragentId | string | Фильтр по контрагенту |
isUrgent | boolean | Фильтр: "Срочные заказы" |
isDeadline | boolean | Фильтр: "Просроченные заказы" |
isStatusDeadline | boolean | Фильтр: "Просроченные по норме времени статуса" |
page | number | Номер страницы выборки ( по умолчанию - 1) |
pageSize | number | Количество элементов в выборке (по умолчанию - 10, максимум - 50) |
filter | string | Текст для поиска по содержимому заказа |
dateCreate | array | Фильтр по дате создания |
dateFinish | array | Фильтр по дате готовности |
dateClose | array | Фильтр по дате выдачи |
deadline | array | Фильтр по дате крайнего срока |
statusDeadline | array | Фильтр по дате крайнего срока статуса |
lastAction | array | Фильтр по дате последнего изменения |
num | number | Номер заказа (числовой номер, ищет по точному соответствию номера заказа без учета префикса) |
numer | string | Номер заказа (текстовый номер, ищет по частичному совпадению номера заказа с учетом префикса) |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Список заказов без привязки к мастерской
GET
https://api.livesklad.com/company/orders
Возвращает массив заказов найденных по всем мастерским. Для получения списка заказов у API должен быть настроен доступ к заказам Для сортировки результата необходимо в параметре sort передать строку "<название_поля> ASC" или "<название_поля> DESC". Где ASC - сортировать по возрастанию, DESC - сортировать по убыванию, <название_поля> - поле по которому осуществляется сортировка, может быть одно из: id, sn, typeOrder, manager, closeManager, master, brand, model, typeDevice, node, problem, completeSet, number, num, dateCreate, lastAction, dateClose, dateFinish, deadline, statusDeadline, counteragent, address, summ, cash, status, isUrgent. По умолчанию заказы сортируются от новых к старым Фильтры по датам передаются в виде массива из двух чисел в формате Unix (в миллисекундах), где первый число - это начало диапазона, а второе - конец диапазона. Если какая-то граница диапазона отсутствует, то вместо нее нужно передать null. Например [1690837200000,1693515599999] или [null,1693515599999]
Из списка с любым заданным набором фильтров можно получить максимум 10000 элементов, то есть максимальное значение для page * pageSize = 10000. Чтобы получить другие элементы, нужно либо изменить фильтр, либо изменить сортировку
Query Parameters
Name | Type | Description |
---|---|---|
isVisible | boolean | Фильтр по удаленным заказам. Если true - будут считаны только не удаленные заказы, если false - будут считаны только удаленные заказы, если параметр не отсутствует - будут считаны все заказы |
sort | string | Сортировка |
statusIds | array | Фильтр по статусам заказов, передается в виде массива id статусов |
masterId | string | Фильтр по мастеру которому назначен заказ |
managerId | string | Фильтр по менеджеру которому назначен заказ |
counteragentId | string | Фильтр по контрагенту |
isUrgent | boolean | Фильтр: "Срочные заказы" |
isDeadline | boolean | Фильтр: "Просроченные заказы" |
isStatusDeadline | boolean | Фильтр: "Просроченные по норме времени статуса" |
page | number | Номер страницы выборки (по умолчанию - 1) |
pageSize | number | Количество элементов в выборке (по умолчанию - 10, максимум - 50) |
filter | string | Текст для поиска по содержимому заказа |
dateCreate | array | Фильтр по дате создания |
dateFinish | array | Фильтр по дате готовности |
dateClose | array | Фильтр по дате выдачи |
deadline | array | Фильтр по дате крайнего срока |
statusDeadline | array | Фильтр по дате крайнего срока статуса |
lastAction | array | Фильтр по дате последнего изменения |
num | number | Номер заказа (числовой номер, ищет по точному соответствию номера заказа без учета префикса) |
number | string | Номер заказа (текстовый номер, ищет по частичному совпадению номера заказа с учетом префикса) |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Создание заказа
POST
https://api.livesklad.com/shops/{id}/orders
Создает заказ в мастерской. Для создания заказа у API должен быть настроен доступ к заказам и и доступ к соответствующей мастерской, так же должен быть установлен доступ на создание заказов
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | id мастерской |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Request Body
Name | Type | Description |
---|---|---|
counteragentId | string | id контрагента |
name | string | Имя контрагента |
address | string | Адрес контрагента |
phones | array | Телефоны контрагента, передаются в виде массива строк |
string | email контрагента | |
isBuyer | boolean | Контрагент является покупателем (по умолчанию - false) |
isVendor | boolean | Контрагент является поставщиком (по умолчанию - false) |
counteragentNode | string | Примечание контрагента |
isSendSms | boolean | Контрагенту можно отправлять смс-сообщения (по умолчанию - false) |
rating | number | Рейтинг контрагента (обычный: 0, негативный клиент: -1, позитивный: 1) |
typeOrderId* | string | id типа заказа |
isUrgent | boolean | Срочный заказ (по умолчанию - false) |
masterId | string | id мастера которому необходимо назначить заказ |
managerId | string | id менеджера которому необходимо назначить заказ |
deadline | number | Крайний срок заказа (передается в формате Unix, в миллисекундах) |
typeDevice | string | Тип устройства |
brand | string | Марка |
model | string | Модель |
sn | string | Серийный номер |
problem | array | Список неисправностей, передается в виде массива строк |
completeSet | array | Комплектация, передается в виде массива строк |
cashRegisterId | string | id кассы в которую будет принята предоплата |
money | number | Сумма предоплаты наличными |
bank | number | Сума предоплаты безналичными |
approximatePrice | string | Предварительная стоимость |
orderNode | string | Примечание к заказу |
appearance | array | Внешний вид, передается в виде массива строк |
color | string | Цвет |
customFields | array | Массив пользовательских полей |
howKnowId | string | id источника рекламы |
Контрагент при создании заказ может быть указан двумя способами: 1) counteragentId - id уже существующего контрагента 2) name, typeCounteragentId, phones, isBuyer, isVendor, email, address, isSendSms, rating, counteragentNode, howKnowId - данные контрагента которого необходимо создать при создании заказа. В случае если не указан typeCounteragentId, используется значение указанное в системе по умолчанию. Один из параметров counteragentId или name - обязателен.
В customFields передаются пользовательские поля по заказу и контрагенту (в том случае если контрагент создается при создании заказа). Поле передается в формате:
В случае если по заказу нужно внести предоплату, необходимо указать параметры cashRegisterId и какой-то из параметров money или bank (в случае смешанной оплаты можно указать сразу оба параметра)
По умолчанию для создания заказа обязательным является только поле typeOrderId и одно из полей counteragentId или name. Но в случае если для указанного типа заказа (определяется по typeOrderId) изменена форма заказа, то обязательными могут быть так же и другие поля
Для создания контрагента при создании заказа, по умолчанию обязательным является только поле name. Но в случае если для типа контрагента указанного в системе по умолчанию, изменена форма контрагента, то обязательными могут быть так же и другие поля.
Если указать поле howKnowId, то для заказа будет прописан источник рекламы. Если при создании заказа создается новый контрагент, а не используется уже существующий, то для созданного контрагента будет прописан тот же источник рекламы.
Список типов заказов
GET
https://api.livesklad.com/type-orders
Возвращает массив типов заказов
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Список пользовательских полей для типа заказа
GET
https://api.livesklad.com/type-orders/{id}/fields
Возвращает массив пользовательских полей для типа заказов
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | id типа заказов |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Информация о заказе
GET
https://api.livesklad.com/orders/{id}
Возвращает информацию о заказе. Для получения информации о заказе у API должен быть настроен доступ к заказам, так же в настройках статусов у API должен быть настроен доступ на просмотр заказов в нужных статусах
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | id заказа |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Изменить заказ
PATCH
https://api.livesklad.com/orders/{id}
Для изменения заказа в настройках API должен быть установлен доступ к заказам. Так же в настройках статусов у API должен быть настроен доступ на редактирование заказов в нужных статусах
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | id заказ |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Токен авторизации |
Request Body
Name | Type | Description |
---|---|---|
howKnowId | string | id источника рекламы (изменяет источник рекламы заказа) |
statusId | string | id статуса |
typeOrderId | string | id типа заказа |
isUrgent | boolean | Срочный заказ |
managerId | string | id менеджера которому необходимо назначить заказ |
masterId | string | id мастера которому необходимо назначить заказ |
deadline | number | Крайний срок |
typeDevice | string | Тип устройства |
brand | string | Марка |
model | string | Модель |
sn | string | Серийный номер |
problem | array | Список неисправностей, передается в виде массива строк |
completeSet | array | Комплектация, передается в виде массива строк |
approximatePrice | string | Предварительная стоимость |
orderNode | string | Примечание к заказу |
appearance | array | Внешний вид, передается в виде массива строк |
cashRegisterId | string | id кассы в которую будет принята оплата |
money | number | Сумма наличными |
bank | number | Сумма безналичными |
nodePay | string | Примечание к оплате |
color | string | Цвет |
recommendation | string | Вердикт / рекомендации |
comment | string | Комментарий |
customFields | array | Массив пользовательских полей |
counteragentId | string | id контрагента |
В customFields передаются пользовательские поля по заказу и контрагенту (в том случае если контрагент создается при создании заказа). Поле передается в формате:
Произвести оплату по заказу (параметры cashRegisterId, money, bank, nodePay) возможно только в том случае если у заказа меняется статус (указан параметр statusId) и у данного статуса в настройках задан параметр "Затребовать оплату при перехода заказа в этот статус".
Удалить заказ
DELETE
https://api.livesklad.com/orders/{id}
Для удаления заказа в настройках API должен стоять соответствующий доступ
Path Parameters
Name | Type | Description |
---|---|---|
id | string | id заказа |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Токен авторизации |
Last updated