Перейти к основному содержимому

Общий интерфейс

API TS - Общий интерфейс​

Приемка​

Операция создания приёмки​

Операция: ts/goodReceipts/create

Метод: POST

Создаёт приёмку с позициями. Дата создания устанавливается текущая.

Место хранения указывается в панели управления в разделе Настройки склада → общие.

Для создания приёмки у пользователя должно быть включено право доступа к API "создание приёмки", а так же активный договор поставки.

Параметры запроса

ПараметрОписание
userloginИмя контрагента-поставщика
userpswmd5-хэш пароля контрагента-поставщика
supplierIdВнутренний код контрагента-поставщика
positionsсписок позиций
supNumber[необязательный] номер отгрузки поставщика
supShipmentDate[необязательный] дата и время отгрузки поставщика в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС
externalId[необязательный] Параметр для связи с внешними сервисами
ПолеОписание
brandНазвание производителя (бренд - необзятально, если передан productId)
numberНомер детали (код производителя - необзятально, если передан productId)
productIdID товара в своем справочнике, необязательно, если переданы 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Имя контрагента
userpswmd5-хэш пароля контрагента
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Имя контрагента
userpswmd5-хэш пароля контрагента
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Имя контрагента
userpswmd5-хэш пароля контрагента
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Имя контрагента
userpswmd5-хэш пароля контрагента
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Имя контрагента
userpswmd5-хэш пароля контрагента
auto[необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число)
creatorId[необязательный] идентификатор сотрудника-создателя
expertId[необязательный] идентификатор сотрудника-эксперта
orderPickingId[необязательный] идентификатор отгрузки
positionStatuses[необязательный] массив статусов позиций
tagIDs[необязательный] массив идентификаторов тегов
positionAuto[необязательный] автоопределяемый параметр для поиска по позициям операции
number[необязательный] номер операции
dateStart[необязательный] начальная дата диапазона поиска в формате rfc3339
dateEnd[необязательный] конечная дата диапазона поиска в формате rfc3339
executionDateStart[необязательный] Начальная дата диапазона поиска по времени завершения (rfc3339).
executionDateEnd[необязательный] Конечная дата диапазона поиска по времени завершения (rfc3339).
skip[необязательный] количество операций в ответе, которое нужно пропустить
limit[необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение.
output[необязательный] формат вывода, 'e' - загрузка дополнительной информации(операция отгрузки и договор), 's' - будет возвращена дополнительная информация о количестве позиций во всех возможных статусах.
fields[необязательный] загрузка дополнительной информации. Строка со следующими параметрами через запятую:

Пример запроса

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Имя контрагента
userpswmd5-хэш пароля контрагента
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-брак, 4-недовоз, 5-пересорт)
skip[необязательный] количество операций в ответе, которое нужно пропустить
limit[необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение.
output[необязательный] формат вывода, 'e' - загрузка дополнительной информации (справочные товары)
fields[необязательный] Загрузка дополнительной информации. Строка со следующими параметрами через запятую:

Пример запроса

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Имя контрагента
userpswmd5-хэш пароля контрагента
orderPickingId[обязательный] идентификатор отгрузки из которой возвращается товар
positions[обязательный] список позиций
externalId[необязательный] Параметр для связи с внешними сервисами
ПолеОписание
orderPickingPositionIdИдентификатор позиции отгрузки
quantityКоличество
typeТип возврата(1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
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-брак, 4-недовоз, 5-пересорт)
orderPickingGoodIdИдентификатор позиции отгрузки
oldItemIdИдентификатор партии, отгруженной по указанной отгрузке
itemIdИдентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе"
locIdИдентификатор места хранения принятого товара
quantityКоличество
attrsСписок добавленных к позиции документов и изображений
pickingDateДата и время выдачи товара обратно клиенту
commentКомментарий
productКарточка товара
orderPickingGoodОбъект позиции отгрузки
orderPickingОбъект отгрузки
availableQuantityКоличество товара, доступное к возврату по позиции отгрузки

Пакетное создание позиций возврата покупателя​

Операция: ts/customerComplaints/createPositionMultiple

Метод: POST

Для создания позиций возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"

Параметры запроса

ПараметрОписание
userloginИмя контрагента
userpswmd5-хэш пароля контрагента
positions[обязательный] список позиций
customerComplaintId[обязательный, если не указан customerComplaintId] ид операции возврата
customerComplaint[обязательный, если не указан customerComplaint] данные для создания операции возврата

Узел positions содержит набор объектов вида:

ПолеОписание
orderPickingGoodId[обязательный] Идентификатор позиции отгрузки
quantity[обязательный] Количество
type[обязательный] Тип возврата (1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
comment[обязательный] Комментарий
attrsприложенные файлы
externalId[необязательный] Параметр для связи с внешними сервисами
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-брак, 4-недовоз, 5-пересорт)
orderPickingGoodIdИдентификатор позиции отгрузки
oldItemIdИдентификатор партии, отгруженной по указанной отгрузке
itemIdИдентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе"
locIdИдентификатор места хранения принятого товара
quantityКоличество
attrsСписок добавленных к позиции документов и изображений
pickingDateДата и время выдачи товара обратно клиенту
commentКомментарий
externalIdПараметр для связи с внешними сервисами

Изменение позиции возврата покупателя​

Операция: ts/customerComplaints/updatePosition

Метод: POST

Возможно изменение только количества товара позиции. Изменение возможно только в статусе "новый".

Для изменения позиции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"

Параметры запроса

ПараметрОписание
userloginИмя контрагента
userpswmd5-хэш пароля контрагента
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-брак, 4-недовоз, 5-пересорт)
orderPickingGoodIdИдентификатор позиции отгрузки
oldItemIdИдентификатор партии, отгруженной по указанной отгрузке
itemIdИдентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе"
locIdИдентификатор места хранения принятого товара
quantityКоличество
attrsСписок добавленных к позиции документов и изображений
pickingDateДата и время выдачи товара обратно клиенту
commentКомментарий
productКарточка товара
orderPickingGoodОбъект позиции отгрузки
orderPickingОбъект отгрузки
availableQuantityКоличество товара, доступное к возврату по позиции отгрузки

Отмена позиции возврата покупателя​

Операция: ts/customerComplaints/cancelPosition

Метод: POST

Отмена позиции возможна только в статусе "новый". Отмена позиции происходит путём изменения статуса позиции в статус 6 - аннулировано.

Для отмены позиции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"

Параметры запроса

ПараметрОписание
userloginИмя контрагента
userpswmd5-хэш пароля контрагента
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-брак, 4-недовоз, 5-пересорт)
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*"Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
goodCodeВнутренний код поставщика

Пример запроса

`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

Метод возвращает пустой ответ

Стандартный набор параметров позиции корзины​

iduint - уникальный идентификатор заказа клиента
brandstring - бренд товара
numberFixstring - "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
quantityfloat - количество
pricefloat - цена одной позиции товара
createDatedatetime - дата и время добавления позиции в корзину
updateDatedatetime - дата и время изменения позиции в корзине
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список найденных способов доставки

Объект способа доставки​

ПараметрОписание
idid способа доставки
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номер заказа, если не указан, то сформируется согласно шаблону номеров заказов, если указан, то проверяется на уникальность
createTimerfc3339 - дата и время создания заказа, если не указан, заполняется автоматически, не может быть из будущего
positions*список ID позиций корзины
delivery[methodId]*ID способа доставки. Его можно получить через, используя операцию
delivery[meetData][officeId]*ID офиса самовывоза. Обязателен, если methodId имеет type=pickup и блок offices в своем объекте.
delivery[meetData][address]*Если methodId имеет type=pickup и блок addresses в своем объекте, то в параметре передается адрес самовывоза из указанного methodId. При такой ситуации параметр обязателен для заполнения.
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комментарий к заказу или позиции заказа
dateStartrfc3339 начальная дата диапазона поиска по дате создания заказа (обязательное, если задан dateEnd)
dateEndrfc3339 конечная дата диапазона поиска по дате создания заказа (обязательное, если задан dateStart)
updateDateStartrfc3339 начальная дата диапазона поиска по дате обновления заказа
updateDateEndrfc3339 конечная дата диапазона поиска по дате обновления заказа
deadlineDateStartrfc3339 начальная дата диапазона поиска по дате ожидаемой поставки позиций заказа
deadlineDateEndrfc3339 конечная дата диапазона поиска по дате ожидаемой поставки позиций заказа
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*идентификатор позиции заказа
additionalInfostring, доп. информация, значения через запятую

Пример запроса

`https://demo.public.api.abcp.ru/ts/positions/get?userlogin=username&userpsw=md5pass&positionId=11112`

Метод возвращает объект позиции заказа.

Получение списка позиций​


Операция: GET /ts/positions/list

Параметры запроса

ПараметрОписание
userlogin*Имя контрагента
userpsw*md5-хэш пароля контрагента
brandstring, бренд товара, полное совпадение
messagestring, комментарий к позиции
agreementIduint, идентификатор соглашения
managerIduint, идентификатор менеджера
noManagerAssignedфлаг, добавляющий в выборку позиции без назначенного менеджера; используется с managerId
dateStartstring, минимальная дата создания позиций заказов
dateEndstring, максимальная дата создания позиций заказов
updateDateStartstring, минимальная дата обновления заказов
updateDateEndstring, максимальная дата обновления заказов
deadlineDateStartstring, минимальная дата ожидаемая дата поставки на склад
deadlineDateEndstring, максимальная дата ожидаемая дата поставки на склад
routeIds[]uint, идентификаторы маршрутов
distributorIds[]uint, идентификаторы прайс-листов
ids[]uint, идентификаторы позиций заказов клиентов
orderIds[]uint, идентификаторы заказов клиентов
productIds[]uint, идентификаторы карточек товаров через запятую
statuses[]string, список статусов позиций заказов
tagIds[]uint, id тегов через запятую
skipuint, смещение (по умолчанию 0)
limituint, ограничение по кол-ву заказов в выдаче
additionalInfostring, доп. информация, значения через запятую

Пример запроса

`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, идентификатор позиции заказа
additionalInfostring, доп. информация, значения через запятую

Пример запроса

`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, идентификаторы позиций через запятую
additionalInfostring, доп. информация, значения через запятую

Пример запроса

`https://demo.public.api.abcp.ru/ts/positions/massCancel`

Параметры POST

userlogin=username&userpsw=md5pass&positionIds=252653,25265

Метод возвращает список позиций.

Объект позиции заказа​


iduint, идентификатор
orderIduint, ID заказа
statusstring, Статус позиции
routeIduint, ID маршрута
distributorIduint, ID прайс-листа
refusalПризнак желания клиента отказаться от покупки товара
quantityfloat, Количество
pricefloat, Цена одной позиции
prepaymentAmountfloat, Сумма предоплаты
createDatedatetime, Время создания
updateDatedatetime, Время изменения
deadlineTimedatetime, дата и время поставки товара на склад, вычисляется в момент создания createTime + deadline (часы)
deadlineTimeMaxdatetime, дата и время поставки товара на склад, вычисляется в момент создания createTime + deadlineMax (часы)
productдоп. информация о товаре
product[brand]string, Бренд (из корзины)
product[number]string, номер по формату в ответе от поставщика (из результата поиска)
product[description]string, описание
product[packing]uint, Кратность
product[availability]int, Доступно
product[deadline]uint, Срок поступления на склад в часах (из корзины)
product[deadlineMax]uint, Срок поступления на склад максимальный в часах (из корзины)
deliveryobject, информация о доставке (*если использовался additionalInfo=delivery при получении позиции)
unpaidAmountfloat, суммарная неоплаченная стоимость позиций (*если использовался additionalInfo=unpaidAmount при получении позиции)

Список возможных статусов позиции заказа​


prepaymentтребуется предоплата
canceledаннулировано
newновый
supOrderзаказ поставщику
supOrderCanceledзаказ поставщику, отказ
reservationбронь
orderPickingотгрузка
deliveryдоставка
finishedзавершен

Информация о доставке, позиции заказа клиента


statusstring, состояние
trackNumberstring, номер для отслеживания
createDatedatetime, дата создания
startTimedatetime, начало интервала доставки
pricefloat, цена
prepaidfloat, сумма предоплаты
volumefloat, суммарный объем
addressstring, полный адрес
commentstring, дополнительная информация
contactstring, телефон для связи
personstring, контактное лицо
employeePersonstring, имя сотрудника
employeeContactstring, телефон сотрудника
resellerCommentstring, комментарий о месте доставки от магазина

Значения параметра additionalInfo


deliveryинформация о доставке
unpaidAmountсумма, которую должен уплатить клиент, либо оставшаяся сумма заказа/отгрузки
statusNameВыводит наименование статуса позиции заказа, как в ЛК. Если позиция заказа клиента находится в заказе поставщику, дополнительно выводится информация о статусе заказа поставщику в параметре statusNameSO.

Договоры​

Получение списка договоров​


Операция: GET /ts/agreements/list

Параметры запроса

ПараметрТипОписание
userlogin*stringИмя контрагента
userpsw*stringmd5-хэш пароля контрагента
ids[]uintСписок идентификаторов договоров
contractorRequisiteIds[]uintСписок идентификаторов платёжных реквизитов контрагента
shopRequisiteIds[]uintСписок идентификаторов платёжных реквизитов магазина
isActiveboolПризнак активности
isDeleteboolПризнак логического удаления
isDefaultboolПризнак договора по умолчанию
agreementTypeuint8Тип договора
relationTypeuint8Тип отношений
numberstringЧастичный номер
taxNumberstringИдентификационный номер налогоплательщика (ИНН для РФ)
currencystringВалюта
dateStartstringМинимальная дата создания в формате RFC3339
dateEndstringМаксимальная дата создания в формате RFC3339
creditLimitfloat64Лимит кредита
limituintМаксимально количество объектов в выдаче
offsetuintПропуск объектов в выдаче

Пример запроса

`https://demo.public.api.abcp.ru/ts/agreements/list?userlogin=username&userpsw=md5pass`

Метод возвращает объект вида:

ПолеОписание
totalчисло найденных договоров
listсписок найденных договоров
к сведению

Для пользователя API-администратор операция вернет данные всех контрагентов с учетом заданных параметров.

Объект договора​

ПараметрТипОписание
iduintИдентификатор
createDatedatetimeДата создания
numberstringНомер
namestringНазвание договора
currencystringВалюта
contractorIduintИдентификатор контрагента
shopLegalPersonIduint|nullИдентификатор ЮЛ магазина
contractorLegalPersonIduint|nullИдентификатор ЮЛ контрагента
shopRequisiteIduint|nullИдентификатор реквизитов магазина
contractorRequisiteIduint|nullИдентификатор реквизитов контрагента
balancefloat64Баланс
agreementTypeuint8Тип договора (оферта или обычный)
relationTypeuint8Тип отношений (покупка или продажа)
isActiveboolПризнак активности
isDeleteboolПризнак логического удаления
isDefaultboolПризнак договора по умолчанию
creditLimitfloat64Лимит кредита
repaymentPerioduint8Отсрочка платежа
isPaymentLateboolСтоп-лист/запрет отгрузки/платеж просрочен
latePaymentDatedatetime|nullДата и время начала отсрочки платежей

Заказы поставщикам​

Получение списка заказов​


Операция: POST /ts/supplierOrders/orders/list

Параметры запроса

ПараметрТипОписание
sendStatuses[]uintСписок статусов отправки заказа. Варианты: 1 - отправляется, 2 - отправлен, 3 - ошибка, 4 - отправка не требуется
createDateStartstringНачальная дата в диапазоне поиска по дате создания заказа. Форма rfc3339.
createDateEnd[]uintКонечная дата в диапазоне поиска по дате создания заказа. Форма rfc3339.
sendDateStartstringНачальная дата в диапазоне поиска по дате отправки заказа. Форма rfc3339.
sendDateEnd[]uintКонечная дата в диапазоне поиска по дате отправки заказа. Форма rfc3339.
limituintМаксимально количество объектов в выдаче
skipuintПропуск объектов в выдаче

Получение списка позиций заказов​


Операция: POST /ts/supplierOrders/positions/list

Параметры запроса

ПараметрТипОписание
statuses[]uintСписок статусов
orderIduintидентификатор заказа
additionalInfostringДополнительная информация: products - добавить инфу о товарах
limituintМаксимально количество объектов в выдаче
skipuintПропуск объектов в выдаче

Варианты значения поля Статус:

1 - Готова к созданию заказа

2 - Добавлена в заказ

3 - Подтвержден поставщиком

4 - В пути

5 - Прибыл

6 - Выполнен

7 - Отказ