Содержание
- 1 API TS - Общий интерфейс
- 1.1 Приемка
- 1.2 Отгрузка
- 1.3 Возвраты покупателя
- 1.4 Работа с Корзиной
- 1.4.1 Добавление позиции в корзину
- 1.4.2 Обновление позиции в корзине
- 1.4.3 Получение списка позиций в корзине
- 1.4.4 Проверка наличия позиции в корзине
- 1.4.5 Получение суммарной информации по позициям корзины
- 1.4.6 Очистка корзины
- 1.4.7 Удаление позиций корзины
- 1.4.8 Стандартный набор параметров позиции корзины
- 1.4.9 Получение доступных способов доставки по позициям корзины
- 1.4.10 Объект способа доставки
- 1.5 Заказы клиентов
- 1.6 Позиции заказов клиентов
- 1.7 Договоры
- 1.8 Заказы поставщикам
API TS - Общий интерфейс
Приемка
Операция создания приёмки
Операция: ts/goodReceipts/create
Метод: POST
Создаёт приёмку с позициями. Дата создания устанавливается текущая.
Место хранения указывается в панели управления в разделе Настройки склада -> общие.
Для создания приёмки у пользователя должно быть включено право доступа к API "создание приёмки", а так же активный договор поставки.
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента-поставщика |
| userpsw | md5-хэш пароля контрагента-поставщика |
| supplierId | Внутренний код контрагента-поставщика |
| positions | список позиций |
| supNumber | [необязательный] номер отгрузки поставщика |
| supShipmentDate | [необязательный] дата и время отгрузки поставщика в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС |
| externalId | [необязательный] Параметр для связи с внешними сервисами |
Узел positions содержит набор объектов вида:
| Поле | Описание |
|---|---|
| brand | Название производителя (бренд - необзятально, если передан productId) |
| number | Номер детали (код производителя - необзятально, если передан productId) |
| productId | ID товара в своем справочнике, необязательно, если переданы brand и number |
| quantity | Количество |
| supBuyPrice | Цена позиции в валюте поставщика |
| manufacturerCountry | [необязательный] Страна производитель - три английские буквы: RUS - Россия, CNH - Китай, DEU - Германия и т.д. ИЛИ цифровой код страны (643 - Россия, 156 - Китай, 276 - Германия) |
| gtd | [необязательный] Номер ГТД |
| warrantyPeriod | [необязательный] Срок гарантийного обслуживания с момента продажи в днях |
| returnPeriod | [необязательный] Срок гарантированного возврата в днях |
| barcodes | [необязательный] Штрихкоды разделённые пробелами |
| comment | [необязательный] Комментарий |
| descr | [необязательный] Описание будущей партии |
| expectedQuantity | [необязательный] Ожидаемое кол-во товара |
| soPositionId | [необязательный] Идентификатор позиции заказа поставщику, на основании которой была создана позиция приемки |
| oldOrderPositionId | [необязательный] Идентификатор позиции старого заказа, на основании которой была создана позиция приемки |
| wearout | [необязательный] Показатель состояния износа товара (б/у) 0 - новый товар, 10 - отличное, 30 - хорошее, 50 - удовлетворительное, 70 - под восстановление, 90 - ремонтный набор. |
| externalId | [необязательный] Параметр для связи с внешними сервисами |
Пример запроса
https://demo.public.api.abcp.ru/ts/goodReceipts/create
Параметры POST
userlogin=username&userpsw=md5pass&code=userCode&positions[0][brand]=febi&positions[0][number]=01089&positions[0][quantity]=3&positions[0][supBuyPrice]=100&positions[0][manufacturerCountry]=rus&positions[0][gtd]=123123&positions[0][warrantyPeriod]=30&positions[0][returnPeriod]=14&positions[0][barcodes]=4027816010666%202053000000666&position[0][expectedQuantity]=7.4&position[0][soPositionId]=123456&position[0][oldOrderPositionId]=3832215&positions[1][brand]=PATRON&positions[1][number]=pse40273&positions[1][quantity]=2&positions[1][supBuyPrice]=75&positions[1][manufacturerCountry]=chn&positions[1][gtd]=3432142154&positions[1][warrantyPeriod]=44&positions[1][returnPeriod]=33&positions[1][barcodes]=46000550077%2046000550088&position[1][expectedQuantity]=7.5&position[1][soPositionId]=123457&position[1][oldOrderPositionId]=3832216
Метод возвращает объект вида:
| Поле | Описание |
|---|---|
| id | Идентификатор созданной приёмки |
Получение списка операций приёмки
Операция: ts/goodReceipts/get
Метод: GET
Для получения списка приёмок у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| output | [необязательный] формат вывода, флаг 'd' - загрузка удалённых операций, 'e' - загрузка дополнительной информации (договора), 's' - суммы по позициям, кол-во позиций |
| auto | [необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число) |
| creatorId | [необязательный] идентификатор сотрудника-создателя |
| workerId | [необязательный] идентификатор сотрудника-исполнителя |
| agreementId | [необязательный] идентификатор договора |
| statuses | [необязательный] статусы через запятую (1 - новая, 2 - в работе, 3 - завершена) |
| number | [необязательный] номер операций |
| dateStart | [необязательный] начальная дата диапазона поиска в формате rfc3339 |
| dateEnd | [необязательный] конечная дата диапазона поиска в формате rfc3339 |
| supNumber | [необязательный] номер отгрузки поставщика |
Пример запроса
https://demo.public.api.abcp.ru/ts/goodReceipts/get?userlogin=username&userpsw=md5pass&limit=30&output=sde&statuses=3
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор операции приёмки |
| number | Номер операции |
| createDate | Дата создания операции |
| status | Статус |
| creatorId | Идентификатор сотрудника-создателя |
| workerId | Идентификатор сотрудника-исполнителя |
| isDelete | Признак удаления |
| supplierId | Идентификатор поставщика |
| agreementId | Идентификатор соглашения |
| supNumber | Номер отгрузки поставщика |
| supShipmentDate | Дата отгрузки поставщика |
| buyAmount | Сумма приёмки в валюте магазина |
| supBuyAmount | Сумма приёмки в валюте договора |
| positionsCount | Количество позиций в операции |
| sumQuantity | Количество товаров в операции |
| agreement | Договор |
| supplier | Поставщик |
| externalId | Параметр для связи с внешними сервисами |
Получение списка позиций приёмки
Операция: ts/goodReceipts/getPositions
Метод: GET
Для получения списка позиций приёмки у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| opId | [обязательный] идентификатор операции |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| output | [необязательный] формат вывода, 'e' - загрузка дополнительной информации (справочные товары) |
| productId | [необязательный] идентификатор товара справочника |
| auto | [необязательный][не менее 3х символов] автоопределяемое поле |
Пример запроса
https://demo.public.api.abcp.ru/ts/goodReceipts/getPositions?userlogin=username&userpsw=md5pass&limit=30&output=e&opId=3
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции приёмки |
| productId | Идентификатора товара в справочнике |
| quantity | Количество |
| supBuyPrice | Цена закупки в валюте договора |
| supToResRate | Курс валюты магазина к валюте договора |
| buyPrice | Цена закупки в валюте магазина |
| sellPrice | Цена продажи |
| manufacturerCountry | Страна производитель товара |
| warrantyPeriod | Гарантийный период в днях |
| returnPeriod | Срок возврата |
| attrs | Дополнительные параметры(штрихкоды, комментарий, описание партии) |
| data | Дополнительные данные о связях позиции приёмки с заказами покупателя и поставщику |
| locId | Идентификатор места хранения |
| product | Карточка товара |
| externalId | Параметр для связи с внешними сервисами |
Отгрузка
Получение списка операций отгрузки (расход)
Операция: ts/orderPickings/get
Метод: GET
Для получения списка операций отгрузки у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| output | формат вывода, флаг 'd' - загрузка удалённых операций, 'e' - загрузка дополнительной информации (договора), 's' - суммы по позициям, кол-во позиций |
| auto | [необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число) |
| creatorId | [необязательный] идентификатор сотрудника-создателя |
| workerId | [необязательный] идентификатор сотрудника-исполнителя |
| agreementId | [необязательный] идентификатор договора |
| status | [необязательный] статусы через запятую (1 - новая, 2 - в работе, 3 - завершена, 4 - аннулирована) |
| number | [необязательный] номер операций |
| dateStart | [необязательный] начальная дата диапазона поиска в формате rfc3339 |
| dateEnd | [необязательный] конечная дата диапазона поиска в формате rfc3339 |
| coOldPosIds | [необязательный] список идентификаторов позиций старых заказов |
Пример запроса
https://demo.public.api.abcp.ru/ts/orderPickings/get?userlogin=username&userpsw=md5pass&limit=30&output=sde&status=3&coOldPosIds[]=11111&coOldPosIds[]=11112
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор отгрузки |
| number | Номер операции |
| createDate | Дата создания операции |
| status | Статус |
| creatorId | Идентификатор сотрудника-создателя |
| workerId | Идентификатор сотрудника-исполнителя |
| isDelete | Признак удаления |
| clientId | Идентификатор клиента |
| agreementId | Идентификатор соглашения |
| agreement | Договор |
| accountDetails | Реквизиты магазина |
| client | Клиент |
| goodSumSellPrice | Стоимость всех товаров операции |
| goodSumClSellPrice | Стоимость всех товаров операции, отформатированная в соответствии с настройками магазина |
| goodPositionsCount | Количество позиций товаров в операции |
| goodSumQuantity | Количество товаров в операции |
| serviceSumSellPrice | Стоимость всех услуг операции |
| serviceSumClSellPrice | Стоимость всех услуг операции, отформатированная в соответствии с настройками магазина |
| servicePositionsCount | Количество позиций услуг в операции |
| serviceSumQuantity | Количество услуг в операции |
Получение списка позиций товаров отгрузки
Операция: ts/orderPickings/getGoods
Метод: GET
Для получения списка позиций товаров отгрузки у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| opId | [обязательный, если не заполнен opIds] идентификатор операции |
| opIds | [обязательный, если не заполнен opId] идентификаторы операции через запятую |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| output | [необязательный] формат вывода, 'e' - загрузка дополнительной информации (справочные товары), 'o' - дополнительно вернуть инфу об операции |
| productId | [необязательный] идентификатор товара справочника |
| itemId | [необязательный] идентификатор партии товара |
| ignoreCanceled | [необязательный] не возвращать позиции аннулированных операций |
Пример запроса
https://demo.public.api.abcp.ru/ts/orderPickings/getGoods?userlogin=username&userpsw=md5pass&limit=30&skip=30&output=eo&opId=3&ignoreCanceled=1
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор отгрузки |
| coPositionId | Идентификатор позиции заказ(в настоящее время не используется) |
| oldCoPositionId | Идентификатор позиции заказа |
| quantity | Количество |
| itemId | Идентификатор партии |
| clToResRate | Курс валюты договора с покупателем к валюте договора |
| sellPrice | Цена продажи |
| сlSellPrice | Цена продажи, отформатированная в соответствии с настройками магазина |
| product | Карточка товара |
| operationInfo | Информация об операции |
| availableQuantityCC | Количество товаров, доступное для возврата |
Возвраты покупателя
Получение списка операций возврата покупателя
Операция: ts/customerComplaints/get
Метод: GET
Для получения списка возвратов у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| auto | [необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число) |
| creatorId | [необязательный] идентификатор сотрудника-создателя |
| expertId | [необязательный] идентификатор сотрудника-эксперта |
| orderPickingId | [необязательный] идентификатор отгрузки |
| positionStatuses | [необязательный] массив статусов позиций |
| tagIDs | [необязательный] массив идентификаторов тегов |
| positionAuto | [необязательный] автоопределяемый параметр для поиска по позициям операции |
| number | [необязательный] номер операции |
| dateStart | [необязательный] начальная дата диапазона поиска в формате rfc3339 |
| dateEnd | [необязательный] конечная дата диапазона поиска в формате rfc3339 |
| executionDateStart | [необязательный] Начальная дата диапазона поиска по времени завершения (rfc3339). |
| executionDateEnd | [необязательный] Конечная дата диапазона поиска по времени завершения (rfc3339). |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| output | [необязательный] формат вывода, 'e' - загрузка дополнительной информации(операция отгрузки и договор), 's' - будет возвращена дополнительная информация о количестве позиций во всех возможных статусах. |
| fields | [необязательный] загрузка дополнительной информации. Строка со следующими параметрами через запятую:
orderPicking - операция отгрузки, по которой создан возврат agreement - договор, по которому выполнена отгрузка posInfo - информация о количестве позиций во всех возможных статусах |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/get?userlogin=username&userpsw=md5pass&limit=30&output=e&pickingId=33
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор операции возврата |
| number | Номер операции |
| createDate | Дата создания операции |
| executionDate | Дата завершения |
| creatorId | Идентификатор сотрудника-создателя |
| expertId | Идентификатор сотрудника-эксперта |
| clientId | Идентификатор клиента |
| agreementId | Идентификатор соглашения |
| agreement | Договор |
| orderPickingId | Идентификатор отгрузки, по который сделан возврат |
| orderPicking | Информация об операции отгрузки |
| positionCount | Количество позиций в операции |
| canceledPositionCount | Количество позиций в статусе "Аннулировано" |
| externalId | Параметр для связи с внешними сервисами |
Получение списка позиций возврата покупателя
Операция: ts/customerComplaints/getPositions
Метод: GET
Для получения списка позиций операции возврата у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| opId | [обязательный, если не заполнен opIds] идентификатор операции |
| opIds | [обязательный, если не заполнен opId] идентификаторы операции через запятую |
| orderPickingGoodId | [необязательный] идентификатор позиции отгрузки |
| orderPickingGoodIds | [необязательный] идентификаторы позиций отгрузки через запятую |
| pickingIds | [необязательный] идентификаторы операции отгрузки через запятую |
| oldCoPositionIds | [необязательный] идентификаторы позиции старого заказа через запятую |
| oldItemID | [необязательный] идентификатор партии из отгрузки |
| itemId | [необязательный] идентификатор созданной партии |
| locId | [необязательный] идентификатор места хранения |
| status | [необязательный] статус позиции |
| dateStart | [необязательный] минимальная дата создания операции |
| dateEnd | [необязательный] максимальная дата создания операции |
| status | статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара) |
| type | тип возврата (1 - возврат, 2 - отказ, 3 - брак.) |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| output | [необязательный] формат вывода, 'e' - загрузка дополнительной информации (справочные товары) |
| fields | [необязательный] Загрузка дополнительной информации. Строка со следующими параметрами через запятую:
product - товар из справочника orderPickingInfo - операция отгрузки; позиция отгрузки, связанная с возвратом; доступное для возврата количество operationInfo - информация об операции supplierReturnPos - связанный возврат поставщику (null, если такого нет) |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/getPositions?userlogin=username&userpsw=md5pass&limit=30&output=e&opId=3&status=2&type=1
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции возрата |
| status | Статус |
| type | Тип возарата |
| orderPickingGoodId | Идентификатор позиции товара в операции отгрузки |
| oldItemId | Идентификатор отгруженной партии |
| itemId | Идентификатор партии, созданной данной позицией возврата |
| quantity | Количество |
| attrs | Объект, содержащий ссылки на загруженные документы и фотографии |
| product | Карточка товара |
| pickingDate | Дата и время выдачи товара клиенту |
| comment | Комментарий |
| orderPickingGood | Информация о позиции операции отгрузки |
| orderPicking | Информация об операции отгрузки |
| availableQuantity | Доступное для возврата количество |
Создание возврата покупателя
Операция: ts/customerComplaints/create
Метод: POST
Для создания операции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| orderPickingId | [обязательный] идентификатор отгрузки из которой возвращается товар |
| positions | [обязательный] список позиций |
| externalId | [необязательный] Параметр для связи с внешними сервисами |
Узел positions содержит набор объектов вида:
| Поле | Описание |
|---|---|
| orderPickingPositionId | Идентификатор позиции отгрузки |
| quantity | Количество |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| comment | Комментарий |
| externalId | Параметр для связи с внешними сервисами |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/create
Параметры POST
userlogin=username&userpsw=md5pass&orderPickingId=100&positions[0][orderPickingPositionId]=1234&positions[0][quantity]=2&positions[0][type]=3&positions[0][comment]=comment%20for%20position0&positions[1][orderPickingPositionId]=1235&positions[1][quantity]=1&positions[1][type]=2&positions[0][comment]=comment%20for%20position1
Метод возвращает объект операции возврата:
| Поле | Описание |
|---|---|
| id | Идентификатор созданной операции |
| number | Номер операции |
| createDate | Дата создания |
| creatorId | Идентификатор пользователя, создавшего опреацию |
| expertId | Идентификатор пользователя, назначенного в качестве эксперта |
| clientId | Идентификатор клиента |
| agreementId | Идентификатор договора с клиентом |
| orderPickingId | Идентификатор отгрузки |
| positionCount | Количество позиций в созданной операции |
| canceledPositionCount | Количество аннулированных позиций |
| positions | Список позиций |
| externalId | Параметр для связи с внешними сервисами |
Узел positions содержит набор объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара) Движение возврата |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по указанной отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| product | Карточка товара |
| orderPickingGood | Объект позиции отгрузки |
| orderPicking | Объект отгрузки |
| availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |
Пакетное создание позиций возврата покупателя
Операция: ts/customerComplaints/createPositionMultiple
Метод: POST
Для создания позиций возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| positions | [обязательный] список позиций |
| customerComplaintId | [обязательный, если не указан customerComplaintId] ид операции возврата |
| customerComplaint | [обязательный, если не указан customerComplaint] данные для создания операции возврата |
Узел positions содержит набор объектов вида:
| Поле | Описание |
|---|---|
| orderPickingGoodId | [обязательный] Идентификатор позиции отгрузки |
| quantity | [обязательный] Количество |
| type | [обязательный] Тип возврата(1-возврат, 2-отказ, 3-брак) |
| comment | [обязательный] Комментарий |
| attrs | приложенные файлы |
| externalId | [необязательный] Параметр для связи с внешними сервисами |
Где attrs содержит следующее:
| docs | список приложенных к позиции документов |
|---|---|
| photos | список приложенных к позиции изображений |
И docs, и photos содержат список объектов приложенных файлов следующего вида:
| name | [обязательный] наименование файла |
|---|---|
| file | [обязательный] сам файл в виде base64-строки |
| description | описание файла |
Узел customerComplaint содержит набор объектов вида:
| Поле | Описание |
|---|---|
| orderPickingId | [обязательный] Идентификатор операции отгрузки |
| number | Номер операции возврата |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/createPositionMultiple
Параметры POST
userlogin=username&userpsw=md5pass&customerComplaint[creatorId]=1234&customerComplaint[orderPickingId]=100&positions[0][orderPickingGoodId]=1000&positions[0][type]=1&positions[0][quantity]=1&positions[0][comment]=comment0positions[1][orderPickingGoodId]=1001&positions[1][type]=3&positions[1][quantity]=2&positions[1][comment]=comment1
Метод возвращает объекты созданных позиций возврата и созданной (или существующей) операции возврата:
| Поле | Описание |
|---|---|
| customerComplaint | Объект операции возврата |
| positions | Список созданных объектов позиций |
Объект customerComplaint имеет следующий вид:
| Поле | Описание |
|---|---|
| id | Идентификатор созданной операции |
| number | Номер операции |
| createDate | Дата создания |
| creatorId | Идентификатор пользователя, создавшего опреацию |
| expertId | Идентификатор пользователя, назначенного в качестве эксперта |
| clientId | Идентификатор клиента |
| agreementId | Идентификатор договора с клиентом |
| orderPickingId | Идентификатор отгрузки |
| sbisStatus | Статус выгрузки в СБИС |
| data | Дополнительная информация о возврате |
| externalId | Параметр для связи с внешними сервисами |
Узел positions же содержит набор объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара) Движение возврата |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по указанной отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| externalId | Параметр для связи с внешними сервисами |
Изменение позиции возврата покупателя
Операция: ts/customerComplaints/updatePosition
Метод: POST
Возможно изменение только количества товара позиции. Изменение возможно только в статусе "новый".
Для изменения позиции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| id | [обязательный] идентификатор позиции возврата покупателя |
| quantity | [обязательный] количество |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/updatePosition
Параметры POST
userlogin=username&userpsw=md5pass&id=1234&quantity=2
Метод возвращает объект позиции возврата:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара) |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по указанной отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| product | Карточка товара |
| orderPickingGood | Объект позиции отгрузки |
| orderPicking | Объект отгрузки |
| availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |
Отмена позиции возврата покупателя
Операция: ts/customerComplaints/cancelPosition
Метод: POST
Отмена позиции возможна только в статусе "новый". Отмена позиции происходит путём изменения статуса позиции в статус 6 - аннулировано.
Для отмены позиции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| id | [обязательный] идентификатор позиции возврата покупателя |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/cancelPosition
Параметры POST
userlogin=username&userpsw=md5pass&id=1234
Метод возвращает объект позиции возврата:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара) |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| product | Карточка товара |
| orderPickingGood | Объект позиции отгрузки |
| orderPicking | Объект отгрузки |
| availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |
Работа с Корзиной
Клиентские операции для работы с корзиной.
* - обязательный параметр
Добавление позиции в корзину
Операция: POST /ts/cart/create
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| brand* | бренд |
| number* | артикул по стандарту ABCP |
| quantity* | количество товара |
| supplierCode* | идентификатор маршрута прайс-листа |
| itemKey* | Код товара, полученный поиском search/articles |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/create
Параметры POST
userlogin=username&userpsw=md5pass&brand=Febi&number=01089&quantity=1&itemKey=###123
Метод возвращает объект позиции добавленной в корзину
Обновление позиции в корзине
Операция: POST /ts/cart/update
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| positionId* | идентификатор позиции в корзине |
| quantity* | новое количество |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/update
Параметры POST
userlogin=username&userpsw=md5pass&quantity=1&positionId=333
Метод возвращает объект позиции в корзине
Получение списка позиций в корзине
Операция: GET /ts/cart/list
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| positionIds | список идентификаторов позиций в корзине, через запятую |
| skip | количество позиций корзины в ответе, которое нужно пропустить |
| limit | максимальное количество позиций корзины, которое должно быть возвращено в ответе |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/list?userlogin=username&userpsw=md5pass&agreementId=1002&positionIds=123,321
Метод возвращает поля:
| total | общее кол-во найденных позиций |
|---|---|
| list | список найденных позиций |
Проверка наличия позиции в корзине
Операция: GET /ts/cart/exist
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| brand* | бренд |
| numberFix* | "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/exist?userlogin=username&userpsw=md5pass&agreementId=1002&brand=Febi&numberFix=01089
Метод возвращает поля:
quantity - количество найденных позиций в корзине
Получение суммарной информации по позициям корзины
Операция: GET /ts/cart/summary
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/summary?userlogin=username&userpsw=md5pass&agreementId=1002
Метод возвращает поля:
| count | количество позиций в корзине |
|---|---|
| quantity | количество товаров в корзине |
| cost | сумма позиций в корзине |
Очистка корзины
Операция: POST /ts/cart/clear
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/clear
Параметры POST
userlogin=username&userpsw=md5pass&agreementId=100
Метод возвращает пустой ответ
Удаление позиций корзины
Операция: POST /ts/cart/deletePositions
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| positionIds* | массив идентификаторов позиций |
Пример запроса
https://demo.public.api.abcp.ru/ts/cart/deletePositions
Параметры POST
userlogin=username&userpsw=md5pass&positionIds[]=1011&positionIds[]=1012
Метод возвращает пустой ответ
Стандартный набор параметров позиции корзины
| id | uint - уникальный идентификатор заказа клиента |
|---|---|
| brand | string - бренд товара |
| numberFix | string - "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы |
| quantity | float - количество |
| price | float - цена одной позиции товара |
| createDate | datetime - дата и время добавления позиции в корзину |
| updateDate | datetime - дата и время изменения позиции в корзине |
| data[description] | string - описание из результатов поиска |
| data[packing] | uint - кратность (количество товара в упаковке) |
| data[availability] | int - наличие у поставщика |
| data[deadline] | uint - срок поступления на склад в часах |
| data[deadlineMax] | uint - срок поступления на склад максимальный в часах |
Получение доступных способов доставки по позициям корзины
Операция: /ts/deliveryMethod/forCo
Метод: GET
Параметры запроса (* - обязательный параметр)
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| cartPositionIds* | id позиций корзины через запятую |
| type | Тип способа доставки. pickup - Самовывоз, courier - собственный курьер, custom - другое, integration - ТК. |
Пример запроса
https://demo.public.api.abcp.ru/ts/deliveryMethod/forCo?userlogin=username&userpsw=md5pass&cartPositionIds=111,222
Метод возвращает объект вида:
| Поле | Описание |
|---|---|
| total | число найденных способов доставки |
| list | список найденных способов доставки |
Объект способа доставки
| Параметр | Описание |
|---|---|
| id | id способа доставки |
| name | Название способа доставки |
| type | Тип способа доставки |
| price | Стоимость доставки |
| priceNotConfirmed | Признак стоимость уточняется. True означает, что конечная стоимость доставки будет определена после оформления заказа. |
| description | Описание способа доставки |
| dateTimeIntervals[startDate] | Начало интервала доставки |
| dateTimeIntervals[endDate] | Конец интервала доставки |
| offices[id] | id офиса самовывоза |
| offices[name] | Название офиса самовывоза |
| offices[address] | Адрес офиса самовывоза |
| offices[contact] | Контакт офиса самовывоза |
| addresses[address] | Адрес самовывоза |
| addresses[comment] | Комментарий для адреса самовывоза |
| addresses[contact] | Контакт адреса самовывоза |
| addresses[person] | Контактное лицо адреса самовывоза |
Заказы клиентов
Создание заказа по позициям корзины
Операция: /ts/orders/createByCart
Метод: POST
В ПУ, для клиента должны быть разрешены Права доступа к API - "Отправка корзины в заказ"
Параметры запроса (* - обязательный параметр)
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| agreementId | идентификатор соглашения (договора), если не указан, будет задан дефолтный или первый |
| number | номер заказа, если не указан, то сформируется согласно шаблону номеров заказов, если указан, то проверяется на уникальность |
| createTime | rfc3339 - дата и время создания заказа, если не указан, заполняется автоматически, не может быть из будущего |
| positions* | список ID позиций корзины |
| delivery[methodId]* | ID способа доставки. Его можно получить через, используя операцию |
| delivery[meetData][officeId]* | ID офиса самовывоза. Обязателен, если methodId имеет type=pickup и блок offices в своем объекте. |
| delivery[meetData][address]* | Если methodId имеет type=pickup и блок addresses в своем объекте, то в параметре передается адрес самовывоза из указанного methodId. При такой ситуации параметр обязателен для заполнения.
Если methodId имеет type!=pickup, то в параметре передается адрес доставки. В данном случае обязателен, если не передан delivery[meetData][shipmentAddressId] |
| delivery[meetData][shipmentAddressId]* | ID адреса доставки покупателя. Обязателен, если methodId имеет type!=pickup и не передан delivery[meetData][address] |
| delivery[meetData][person]* | контактное лицо. Параметр обязателен, если methodId имеет type!=pickup |
| delivery[meetData][contact]* | контакт(телефон) получателя. Параметр обязателен, если methodId имеет type!=pickup |
| delivery[meetData][comment] | комментарий |
| delivery[timeInterval][startTime] | Не обязательный. В разработке. Начало интервала доставки. |
| delivery[timeInterval][endTime] | Не обязательный. в разработке. Конец интервала доставки. |
| externalId | [необязательный] Параметр для связи с внешними сервисами |
Пример запроса
https://demo.public.api.abcp.ru/ts/orders/createByCart
Параметры POST
userlogin=username&userpsw=md5pass&positions[0]=1001&positions[1]=1002&delivery[meetData][address]=ул.Пушкина дом Кукушкина 42&delivery[meetData][person]=Иванов Ануар
Метод возвращает объект заказа
Получение списка заказов
Операция: /ts/orders/list
Метод: GET
В ПУ, для клиента должны быть разрешены Права доступа к API - "Чтение заказов"
Параметры запроса (* - обязательный параметр)
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| number | номер заказа |
| agreementId | идентификатор соглашения |
| managerId | идентификатор менеджера |
| deliveryId | идентификатор доставки |
| brand | бренд товара, полное совпадение |
| message | комментарий к заказу или позиции заказа |
| dateStart | rfc3339 начальная дата диапазона поиска по дате создания заказа (обязательное, если задан dateEnd) |
| dateEnd | rfc3339 конечная дата диапазона поиска по дате создания заказа (обязательное, если задан dateStart) |
| updateDateStart | rfc3339 начальная дата диапазона поиска по дате обновления заказа |
| updateDateEnd | rfc3339 конечная дата диапазона поиска по дате обновления заказа |
| deadlineDateStart | rfc3339 начальная дата диапазона поиска по дате ожидаемой поставки позиций заказа |
| deadlineDateEnd | rfc3339 конечная дата диапазона поиска по дате ожидаемой поставки позиций заказа |
| orderIds | идентификаторы заказов через запятую |
| productIds | идентификаторы карточек товаров через запятую |
| positionStatuses | статусы позиций заказов через запятую |
| skip | количество заказов в ответе, которое нужно пропустить |
| limit | максимальное количество заказов, которое должно быть возвращено в ответе |
Пример запроса
https://demo.public.api.abcp.ru/ts/orders/list?userlogin=username&userpsw=md5pass&orderIds[]=942
Метод возвращает объект вида:
| Поле | Описание |
|---|---|
| total | число найденных заказов |
| list | список найденных заказов |
Получение одного заказа
Операция: /ts/orders/get
Метод: GET
В ПУ, для клиента должны быть разрешены Права доступа к API - "Чтение заказов"
Параметры запроса (* - обязательный параметр)
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| orderId* | Идентификатор заказа. |
Пример запроса
https://demo.public.api.abcp.ru/ts/orders/get?userlogin=username&userpsw=md5pass&orderId=123
Метод возвращает объект заказа
Отказ от заказа
Операция: /ts/orders/refuse
Метод: POST
В ПУ, для клиента должны быть разрешены Права доступа к API - "Отправка корзины в заказ"
Параметры запроса (* - обязательный параметр)
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| orderId* | Идентификатор заказа принадлежащего контрагенту |
Пример запроса
https://demo.public.api.abcp.ru/ts/orders/refuse
Параметры POST
userlogin=username&userpsw=md5pass&orderId=1231
Метод не возвращает данные, при успешном выполнении операции.
Стандартный набор полей заказа
| id | Идентификатор заказа |
|---|---|
| number | Номер заказа |
| agreementId | Идентификатор соглашения |
| managerId | Идентификатор ответственного менеджера |
| createTime | Время создания |
| updateTime | Время изменения |
| externalId | Параметр для связи с внешними сервисами |
Возможные значения для статусов позиций заказа
new - Новый
reservation - Бронь
finished - Подтверждён/Завершен
prepayment - Требуется предоплата
orderPicking - Отгрузка
delivery - Доставка
canceled - Аннулировано
supOrder - Заказ поставщику
supOrderCanceled - Заказ поставщику Отказ
Позиции заказов клиентов
Операции для работы с позициями заказов клиентов.
* - обязательный параметр
Получение одной позиции
Операция: GET /ts/positions/get
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| positionId* | идентификатор позиции заказа |
| additionalInfo | string, доп. информация, значения через запятую |
Пример запроса
https://demo.public.api.abcp.ru/ts/positions/get?userlogin=username&userpsw=md5pass&positionId=11112
Метод возвращает объект позиции заказа.
Получение списка позиций
Операция: GET /ts/positions/list
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| brand | string, бренд товара, полное совпадение |
| message | string, комментарий к позиции |
| agreementId | uint, идентификатор соглашения |
| managerId | uint, идентификатор менеджера |
| noManagerAssigned | флаг, добавляющий в выборку позиции без назначенного менеджера; используется с managerId |
| dateStart | string, минимальная дата создания позиций заказов |
| dateEnd | string, максимальная дата создания позиций заказов |
| updateDateStart | string, минимальная дата обновления заказов |
| updateDateEnd | string, максимальная дата обновления заказов |
| deadlineDateStart | string, минимальная дата ожидаемая дата поставки на склад |
| deadlineDateEnd | string, максимальная дата ожидаемая дата поставки на склад |
| routeIds | []uint, идентификаторы маршрутов |
| distributorIds | []uint, идентификаторы прайс-листов |
| ids | []uint, идентификаторы позиций заказов клиентов |
| orderIds | []uint, идентификаторы заказов клиентов |
| productIds | []uint, идентификаторы карточек товаров через запятую |
| statuses | []string, список статусов позиций заказов |
| tagIds | []uint, id тегов через запятую |
| skip | uint, смещение (по умолчанию 0) |
| limit | uint, ограничение по кол-ву заказов в выдаче |
| additionalInfo | string, доп. информация, значения через запятую |
Пример запроса
https://demo.public.api.abcp.ru/ts/positions/list?userlogin=username&userpsw=md5pass&brand=Febi&dateStart=2022-05-29 14:20:00&productIds[]=142&productIds[]=143
Метод возвращает объект вида:
| Поле | Описание |
|---|---|
| total | число найденных позиций |
| list | список найденных позиций |
Аннулирование позиции
Операция: POST /ts/positions/cancel
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| positionId* | uint, идентификатор позиции заказа |
| additionalInfo | string, доп. информация, значения через запятую |
Пример запроса
https://demo.public.api.abcp.ru/ts/positions/cancel
Параметры POST
userlogin=username&userpsw=md5pass&positionId=3569
Метод возвращает позицию.
Массовое аннулирование позиций
Операция: POST /ts/positions/massCancel
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin* | Имя контрагента |
| userpsw* | md5-хэш пароля контрагента |
| positionIds* | string, идентификаторы позиций через запятую |
| additionalInfo | string, доп. информация, значения через запятую |
Пример запроса
https://demo.public.api.abcp.ru/ts/positions/massCancel
Параметры POST
userlogin=username&userpsw=md5pass&positionIds=252653,25265
Метод возвращает список позиций.
Объект позиции заказа
| id | uint, идентификатор |
|---|---|
| orderId | uint, ID заказа |
| status | string, Статус позиции |
| routeId | uint, ID маршрута |
| distributorId | uint, ID прайс-листа |
| refusal | Признак желания клиента отказаться от покупки товара |
| quantity | float, Количество |
| price | float, Цена одной позиции |
| prepaymentAmount | float, Сумма предоплаты |
| createDate | datetime, Время создания |
| updateDate | datetime, Время изменения |
| deadlineTime | datetime, дата и время поставки товара на склад, вычисляется в момент создания createTime + deadline (часы) |
| deadlineTimeMax | datetime, дата и время поставки товара на склад, вычисляется в момент создания createTime + deadlineMax (часы) |
| product | доп. информация о товаре |
| product[brand] | string, Бренд (из корзины) |
| product[number] | string, номер по формату в ответе от поставщика (из результата поиска) |
| product[description] | string, описание |
| product[packing] | uint, Кратность |
| product[availability] | int, Доступно |
| product[deadline] | uint, Срок поступления на склад в часах (из корзины) |
| product[deadlineMax] | uint, Срок поступления на склад максимальный в часах (из корзины) |
| delivery | object, информация о доставке (*если использовался additionalInfo=delivery при получении позиции) |
| unpaidAmount | float, суммарная неоплаченная стоимость позиций (*если использовался additionalInfo=unpaidAmount при получении позиции) |
Список возможных статусов позиции заказа
| prepayment | требуется предоплата |
|---|---|
| canceled | аннулировано |
| new | новый |
| supOrder | заказ поставщику |
| supOrderCanceled | заказ поставщику, отказ |
| reservation | бронь |
| orderPicking | отгрузка |
| delivery | доставка |
| finished | завершен |
Информация о доставке, позиции заказа клиента
| status | string, состояние |
|---|---|
| trackNumber | string, номер для отслеживания |
| createDate | datetime, дата создания |
| startTime | datetime, начало интервала доставки |
| price | float, цена |
| prepaid | float, сумма предоплаты |
| volume | float, суммарный объем |
| address | string, полный адрес |
| comment | string, дополнительная информация |
| contact | string, телефон для связи |
| person | string, контактное лицо |
| employeePerson | string, имя сотрудника |
| employeeContact | string, телефон сотрудника |
| resellerComment | string, комментарий о месте доставки от магазина |
Значения параметра additionalInfo
| delivery | информация о доставке |
|---|---|
| unpaidAmount | сумма, которую должен уплатить клиент, либо оставшаяся сумма заказа/отгрузки |
| statusName | Выводит наименование статуса позиции заказа, как в ЛК. Если позиция заказа клиента находится в заказе поставщику, дополнительно выводится информация о статусе заказа поставщику в параметре statusNameSO. |
Договоры
Получение списка договоров
Операция: GET /ts/agreements/list
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| userlogin* | string | Имя контрагента |
| userpsw* | string | md5-хэш пароля контрагента |
| ids | []uint | Список идентификаторов договоров |
| contractorRequisiteIds | []uint | Список идентификаторов платёжных реквизитов контрагента |
| shopRequisiteIds | []uint | Список идентификаторов платёжных реквизитов магазина |
| isActive | bool | Признак активности |
| isDelete | bool | Признак логического удаления |
| isDefault | bool | Признак договора по умолчанию |
| agreementType | uint8 | Тип договора |
| relationType | uint8 | Тип отношений |
| number | string | Частичный номер |
| taxNumber | string | Идентификационный номер налогоплательщика (ИНН для РФ) |
| currency | string | Валюта |
| dateStart | string | Минимальная дата создания в формате RFC3339 |
| dateEnd | string | Максимальная дата создания в формате RFC3339 |
| creditLimit | float64 | Лимит кредита |
| limit | uint | Максимально количество объектов в выдаче |
| offset | uint | Пропуск объектов в выдаче |
Пример запроса
https://demo.public.api.abcp.ru/ts/agreements/list?userlogin=username&userpsw=md5pass
Метод возвращает объект вида:
| Поле | Описание |
|---|---|
| total | число найденных договоров |
| list | список найденных договоров |
Информация
Для пользователя API-администратор операция вернет данные всех контрагентов с учетом заданных параметров.
Для пользователя API-администратор операция вернет данные всех контрагентов с учетом заданных параметров.
Объект договора
| Параметр | Тип | Описание |
|---|---|---|
| id | uint | Идентификатор |
| createDate | datetime | Дата создания |
| number | string | Номер |
| name | string | Название договора |
| currency | string | Валюта |
| contractorId | uint | Идентификатор контрагента |
| shopLegalPersonId | uint|null | Идентификатор ЮЛ магазина |
| contractorLegalPersonId | uint|null | Идентификатор ЮЛ контрагента |
| shopRequisiteId | uint|null | Идентификатор реквизитов магазина |
| contractorRequisiteId | uint|null | Идентификатор реквизитов контрагента |
| balance | float64 | Баланс |
| agreementType | uint8 | Тип договора (оферта или обычный) |
| relationType | uint8 | Тип отношений (покупка или продажа) |
| isActive | bool | Признак активности |
| isDelete | bool | Признак логического удаления |
| isDefault | bool | Признак договора по умолчанию |
| creditLimit | float64 | Лимит кредита |
| repaymentPeriod | uint8 | Отсрочка платежа |
| isPaymentLate | bool | Стоп-лист/запрет отгрузки/платеж просрочен |
| latePaymentDate | datetime|null | Дата и время начала отсрочки платежей |
Заказы поставщикам
Получение списка заказов
Операция: POST /ts/supplierOrders/orders/list
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| sendStatuses | []uint | Список статусов отправки заказа. Варианты: 1 - отправляется, 2 - отправлен, 3 - ошибка, 4 - отправка не требуется |
| createDateStart | string | Начальная дата в диапазоне поиска по дате создания заказа. Форма rfc3339. |
| createDateEnd | []uint | Конечная дата в диапазоне поиска по дате создания заказа. Форма rfc3339. |
| sendDateStart | string | Начальная дата в диапазоне поиска по дате отправки заказа. Форма rfc3339. |
| sendDateEnd | []uint | Конечная дата в диапазоне поиска по дате отправки заказа. Форма rfc3339. |
| limit | uint | Максимально количество объектов в выдаче |
| skip | uint | Пропуск объектов в выдаче |
Получение списка позиций заказов
Операция: POST /ts/supplierOrders/positions/list
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| statuses | []uint | Список статусов |
| orderId | uint | идентификатор заказа |
| additionalInfo | string | Дополнительная информация: products - добавить инфу о товарах |
| limit | uint | Максимально количество объектов в выдаче |
| skip | uint | Пропуск объектов в выдаче |
Варианты значения поля Статус:
1 - Готова к созданию заказа
2 - Добавлена в заказ
3 - Подтвержден поставщиком
4 - В пути
5 - Прибыл
6 - Выполнен
7 - Отказ