API.TS.Admin

Содержание

1 API TS - Административный интерфейс

API TS - Административный интерфейс

Операция быстрого создания приёмки, брони, отгрузки

Операция: /cp/ts/orderPickings/fastGetOut

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
number	[необязательный] Номер отгрузки, если пустой, то будет заполнен автоматически
date	[необязательный] Дата отгрузки в формате RFC3339, если пустая, то будет заполнена автоматически
executionDate	[необязательный] Дата проведения/выполнения в формате RFC3339, если пустая, то будет заполнена из date
clientId^*	Идентификатор клиента
supplierId^*	Идентификатор поставщика
locationId^*	Идентификатор места хранения.
positions^*	Массив объектов позиций отгрузки:
distributorId	[необязательный] Идентификатор прайс-листа
routeId	[необязательный] Идентификатор маршрута.
locale	[необязательный] Локаль. Например ru_RU. Если не передана, то будет взята локаль по-умолчанию для магазина.
orderPickingResellerData	[необязательный] Дополнительная информация в формате json, которая будет сохранена в операцию отгрузки. Например {"checks":["http://example.com/check1","http://example.com/check2"]}

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

Поле	Описание
brand^*	Бренд
numberFix^*	"Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
code	[необязательный] Код товара в системе учета магазина
description	[необязательный] Описание
quantity^*	Количество
supBuyPrice^*	Цена закупки в валюте поставщика, обязательный
supToResRate^*	Курс валюты магазина к валюте поставщика
buyPrice^*	цена закупки в валюте магазина
sellPrice^*	Цена продажи в валюте магазина
clSellPrice^*	Цена продажи в валюте клиента
clToResRate^*	Курс валюты клиента к валюте магазина
manufacturerCountry	[необязательный] Код страны-производителя. Например RUS или CHN
gtd	[необязательный] Номер ГТД
warrantyPeriod	[необязательный] Срок гарантийного обслуживания с момента продажи в днях
externalId	[необязательный] ID позиции для синхронизации с внешней системой, строка до 15 символов
returnPeriod	[необязательный] Срок гарантийного возврата в днях
productCodes	[необязательный] Массив строк, содержащих коды товара
itemCodes	[необязательный] Массив строк, содержащих коды партии товара

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/fastGetOut

Параметры POST

userlogin=username&userpsw=md5pass&clientId=123123&supplierId=321321&distributorId=44444&routeId=555555&locationId=111&locale=ru_RU&positions[0][brand]=Febi&positions[0][numberFix]=01089&positions[0][description]=Качественный антифриз&positions[0][quantity]=22&positions[0][supBuyPrice]=11&positions[0][supToResRate]=11&positions[0][buyPrice]=121&positions[0][sellPrice]=133&positions[0][clSellPrice]=143&positions[0][clToResRate]=1&positions[0][manufacturerCountry]=ALB&positions[0][gtd]=5435236423&positions[0][warrantyPeriod]=22&positions[0][returnPeriod]=14&positions[0][productCodes][]=123123123&positions[0][productCodes][]=456456456&positions[0][itemCodes][]=1212121212&positions[0][itemCodes][]=2121212121

Ответ не содержит данных:

Отгрузка

Получение списка операций отгрузка (расход)

Операция: /cp/ts/orderPickings/get

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[необязательный] Идентификатор операции. При использовании вернётся одна операция, а не список.
clientId	[необязательный] идентификатор клиента.
limit	[необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение.
skip	[необязательный] количество операций в ответе, которое нужно пропустить
output	[необязательный] формат вывода, флаг 'e' - загрузка дополнительной информации (договора, места хранения, доставки, упаковки), 't' - загрузка информации о тегах, 's' - суммы по позициям, кол-во позиций Для указания нескольких флагов стоит писать их слитно, например, output=se
auto	[необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число)
creatorId	[необязательный] идентификатор сотрудника-создателя
workerId	[необязательный] идентификатор сотрудника-исполнителя
agreementId	[необязательный] идентификатор договора
statuses	[необязательный] список статусов (1 - новая, 2 - сборка, 5 - готов к выдаче, 3 - завершена, 4 - аннулирована.)
number	[необязательный] номер операций
dateStart	[необязательный] начальная дата диапазона поиска по времени создания в формате rfc3339
dateEnd	[необязательный] конечная дата диапазона поиска по времени создания в формате rfc3339
updateDateStart	[необязательный] начальная дата диапазона поиска по времени обновления в формате rfc3339
updateDateEnd	[необязательный] конечная дата диапазона поиска по времени обновления в формате rfc3339
executionDateStart	[необязательный] начальная дата диапазона поиска завершения отгрузки в формате rfc3339
executionDateEnd	[необязательный] конечная дата диапазона поиска завершения отгрузки в формате rfc3339
oldCoPosIds	[необязательный] список идентификаторов позиций старых заказов
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: agreement - договор, по которому выполнена отгрузка tags - теги deliveries - связанная доставка

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/get?userlogin=username&userpsw=md5pass&clientId=555&limit=30&output=ste&statuses[]=2&statuses[]=3&oldCoPosIds[]=11111&oldCoPosIds[]=11112

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

Поле	Описание
id	Идентификатор операции отгрузки
number	Номер операции
createDate	Дата создания операции
executionDate	Дата завершения операции
status	Статус
creatorId	Идентификатор сотрудника-создателя
workerId	Идентификатор сотрудника-исполнителя
clientId	Идентификатор клиента
agreementId	Идентификатор соглашения
locId	Идентификатор места сборки товара
sbisStatus	Статус выгрузки в СБИС
data	Дополнительная информация об операции отгрузки
location	Место сборки товара
agreement	Договор
deliveries	Связанные с отгрузкой операции доставки
tags	Теги
packing	Дополнительная информация об этапе упаковки товара, если того требует связанная операция доставки
goodSumSellPrice	Стоимость всех товаров операции
goodSumClSellPrice	Стоимость всех товаров операции, отформатированная в соответствии с настройками магазина
goodPositionsCount	Количество позиций товаров в операции
goodSumQuantity	Количество товаров в операции
serviceSumSellPrice	Стоимость всех услуг операции
serviceSumClSellPrice	Стоимость всех услуг операции, отформатированная в соответствии с настройками магазина
servicePositionsCount	Количество позиций услуг в операции
serviceSumQuantity	Количество услуг в операции
externalId	Параметр для связи с внешними сервисами

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

Операция: /cp/ts/orderPickings/getGoods

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
opId^*	[обязательный, если не заполнен opIds] идентификатор операции.
opIds^*	[обязательный, если не заполнен opId] идентификаторы операции через запятую
limit	[необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение.
skip	[необязательный] количество операций в ответе, которое нужно пропустить
productId	[необязательный] идентификатор товара справочника
itemId	[необязательный] идентификатор партии товара
ignoreCanceled	[необязательный] не возвращать позиции аннулированных операций
pickingDateStart	[необязательный] начальная дата диапазона поиска по времени создания отгрузки в формате rfc3339
pickingDateEnd	[необязательный] конечная дата диапазона поиска по времени создания отгрузки в формате rfc3339
updateDateStart	[необязательный] начальная дата диапазона поиска по времени обновления позиции в формате rfc3339
updateDateEnd	[необязательный] конечная дата диапазона поиска по времени обновления позиции в формате rfc3339
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: item - информация о партии operationInfo - дополнительная информация об операции отгрузки location - информация о месте хранения product - информация о товаре из справочника co - информация о заказе клиента tags - теги

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/getGoods?userlogin=username&userpsw=md5pass&opId=3&limit=30&skip=30&ignoreCanceled=1&fields=item,co

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

Поле	Описание
id	Идентификатор позиции
opId	Идентификатор операции отгрузки
coPositionId	Идентификатор позиции заказ(в настоящее время не используется)
oldCoPositionId	Идентификатор позиции заказа
quantity	Количество
itemId	Идентификатор партии
clToResRate	Курс валюты договора с покупателем к валюте договора
sellPrice	Цена продажи
externalId	Параметр для связи с внешними сервисами
сlSellPrice	Цена продажи, отформатированная в соответствии с настройками магазина
product	Карточка товара
operationInfo	Информация об операции
availableQuantityCC	Количество товаров, доступное для возврата

Создание операции отгрузки по клиентскому заказу

Операция: /cp/ts/orderPickings/createByOldPos

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
opId	[необязательный] идентификатор операции для добавления позиций. Если не указан - будет создана новая операция отгрузки.
statusId	[обязательный при указании флага doneRightAway] статус позиции заказа, в который будут переведены указанные позиции в случае успешного добавления в операцию отгрузки. При указании флага doneRightAway статус должен иметь признак списания.
agreementId	Идентификатор договора. Если не передать - будет выбран договор по-умолчанию или любой активный.
locId	[обязательный] идентификатор места сборки или отгрузки клиентского заказа. Значение "не установлено" - 0.
ppIds	[обязательный] список идентификаторов позиций старых заказов для добавления в отгрузку
createDate	[необязательный] дата и время создания отгрузки в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339), если не указано - используется текущая дата и время
doneRightAway	[необязательный] 1 - сразу завершить операцию после добавления позиций.
output	[необязательный] расширенный формат вывода. 'e' - загрузка дополнительной информации (договора, реквизиты, клиент), 't' - загрузка информации о тегах, 's' - загрузка суммарной информации о позициях Для указания нескольких флагов стоит писать их слитно, например, output=se
markCodes	[Необязательный] Массив кодов маркировки для позиций (формат: [positionId => [code1, code2, ...]])
externalId	[необязательный] Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/createByOldPos

Параметры POST

userlogin=username&userpsw=md5pass&opId=33&statusId=4444&agreementId=1&locId=33&doneRightAway=1&ppIds[]=123123123&ppIds[]=234234234

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

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

Поле	Описание
id	Идентификатор позиции отгрузки
opId	Идентификатор операции
coPositionId	Идентификатор позиции нового заказа(не используется)
oldCoPositionId	Идентификатор позиции старого заказа
quantity	Количество
itemId	Идентификатор партии
clToResRate	Курс валюты клиента к валюте магазина
clSellPrice	Цена продажи в валюте клиента
sellPrice	Цена продажи в валюте магазина
product	Товар
item	Партия
locations	Места хранения
storageZones	Складские зоны
orderPickingGoodLinks	Связи мест хранения позиций
availableQuantityCC	Количество доступное к возврату.
tags	Теги
externalId	Параметр для связи с внешними сервисами

Изменение статуса операции отгрузка

Операция: /cp/ts/orderPickings/changeStatus

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[обязательный] идентификатор операции отгрузка.
operationStatusId	[обязательный] статус в который требуется перевести отгрузку: 1 - новая, 2 - сборка, 5 - готов к выдаче, 3 - завершена, 4 - аннулирована. Движение отгрузки
positionsStatusId	[обязательный при смене статуса операции с 5 на 3 и с 3 на 5] идентификатор статуса в который требуется перевести связанные с отгрузкой позиции заказов. При переводе из статуса "готов к выдаче" в статус "завершена" требуется указать статус с признаком "списание товара на складе". При переводе из статуса "завершена" в статус "готов к выдаче" требуется указать статус с признаком "бронирование товара".

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/changeStatus

Параметры POST

userlogin=username&userpsw=md5pass&id=33&operationStatusId=3&positionsStatusId=4444

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

Поле	Описание
id	Идентификатор позиции
number	Номер операции
createDate	Дата создания
executionDate	Дата завершения операции
status	Статус операции: 1 - новая, 2 - сборка, 5 - готов к выдаче, 3 - завершена, 4 - аннулирована.
creatorId	Идентификатор сотрудника-создателя
workerId	Идентификатор сотрудника-исполнителя
clientId	Идентификатор клиента
agrementId	Идентификатор договора
updateDate	Дата обновления
locId	Идентификатор места хранения
data	Дополнительная информация об операции отгрузки
externalId	Параметр для связи с внешними сервисами

Изменение операции отгрузка

Операция: /cp/ts/orderPickings/update

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[обязательный] идентификатор операции отгрузки.
number	[необязательный] номер операции
creatorId	[необязательный] идентификатор сотрудника-создателя
workerId	[необязательный] идентификатор сотрудника-исполнителя
clientId	[необязательный] идентификатор клиента
agreementId	[необязательный] идентификатор договора
locId	[необязательный] идентификатор места хранения
resellerData	[необязательный] Дополнительная информация в формате json, которая будет сохранена в операцию отгрузки. Например {"checks":["http://example.com/check1","http://example.com/check2"]}
executionDate	[необязательный] дата и время выполнения операции, формат rfc3339 (ее можно изменить только для завершенной отгрузки, status=3)
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: agreement - договор, по которому выполнена отгрузка tags - теги

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/update

Параметры POST

userlogin=username&userpsw=md5pass&id=33&agreementId=3&workerId=345&number=otgruzka-33

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

Поле	Описание
id	Идентификатор позиции
number	Номер операции
createDate	Дата создания
status	Статус операции: 1 - новая, 2 - сборка, 5 - готов к выдаче, 3 - завершена, 4 - аннулирована.
creatorId	Идентификатор сотрудника-создателя
workerId	Идентификатор сотрудника-исполнителя
clientId	Идентификатор клиента
agrementId	Идентификатор договора
locId	Идентификатор места хранения
data	Дополнительная информация об операции отгрузки
agreement	Договор
accountDetails	Реквизиты
client	Клиент
tags	Теги
goodSumSellPrice	Сумма (количество * цена продажи в валюте магазина) по позициям товара
goodSumClSellPrice	сумма (количество * цена продажи в валюте клиента) по позициям товара
goodPositionsCount	Количество позиций товара
goodSumQuantity	Суммарное количество товара по позициям
serviceSumSellPrice	Сумма (количество * цена продажи в валюте магазина) по позициям услуг
serviceSumClSellPrice	Сумма (количество * цена продажи в валюте клиента) по позициям услуг
servicePositionsCount	Количество позиций услуг
serviceSumQuantity	Суммарное количество услуг по позициям
externalId	Параметр для связи с внешними сервисами

Удаление позиции товара из операции отгрузки

Операция: /cp/ts/orderPickings/deletePosition

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[обязательный] идентификатор позиции операции отгрузки.

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/deletePosition

Параметры POST

userlogin=username&userpsw=md5pass&id=33

Ответ не содержит данных.

Добавление кодов маркировки к позиции операции отгрузки

Операция: /cp/ts/orderPickings/markCodes/add

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderPickingGoodId	[Обязательный] Идентификатор позиции операции отгрузки
markCodes	[Обязательный] Коды маркировки в base64, через запятую

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/markCodes/add

Параметры POST

userlogin=username&userpsw=md5pass&orderPickingGoodId=52467&markCodes=code1,code2,code3

Метод возвращает массив объектов кодов маркировки.

Объект кода маркировки

Поле	Описание
code	Код маркировки в base64
opPosId	Идентификатор позиции операции отгрузки

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

Операция: /cp/ts/orderPickings/markCodes/list

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderPickingId	[Необязательный] Идентификатор операции отгрузки
orderPickingGoodIds	[Необязательный] Идентификаторы позиций операции отгрузки, через запятую. Позиции должны принадлежать одной операции отгрузки.
skip	[Необязательный] Количество кодов в ответе, которое нужно пропустить. По умолчанию 0.
limit	[Необязательный] Максимальное количество кодов, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан, будет установлено максимально возможное значение.

Для получения кодов маркировки необходимо указать один из параметров(orderPickingId или orderPickingGoodIds).

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/markCodes/list?userlogin=username&userpsw=md5pass&orderPickingGoodIds=1234,1235,1236,1237&skip=0&limit=100

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

Поле	Описание
list	Массив объектов кодов маркировки
total	Количество кодов

Удаление кодов маркировки у позиции операции отгрузки

Операция: /cp/ts/orderPickings/markCodes/delete

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderPickingGoodId	[Обязательный] Идентификатор позиции операции отгрузки
markCodes	[Обязательный] Коды маркировки в base64, через запятую

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

https://demo.public.api.abcp.ru/cp/ts/orderPickings/markCodes/delete

Параметры POST

userlogin=username&userpsw=md5pass&orderPickingGoodId=52467&markCodes=code1,code2,code3

Ответ не содержит данных.

Возврат покупателя

Получение списка возвратов покупателя

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

Метод: GET

Возвращает список операций возврата покупателя

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[необязательный] Идентификатор операции. При использовании вернётся одна операция, а не список.
clientId	[необязательный] Идентификатор клиента для фильтра операций.
creatorId	[необязательный] Идентификатор сотрудника-создателя.
expertId	[необязательный] Идентификатор сотрудника-эксперта.
auto	[необязательный] Автоопределяемый параметр для поиска по операции.
number	[необязательный] Номер операции.
orderPickingId	[необязательный] Идентификатор операции отгрузки по выдаче клиенту.
positionStatuses	[необязательный] Поиск операций, которые содержат позиции в указанных статусах. Параметр указывается цифрами через запятую: 1 - Новая 2 - В работе 3 - Отказ 4 - Завершено 5 - Возвращено клиенту 6 - Аннулировано 7 - Отклонено 8 - Ожидаем возврат товара Движение возврата
positionType	[необязательный] поиск операций, которые содержат позиции указанного типа(1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
positionAuto	[необязательный] - автоопределяемый параметр для поиска по позициям операции.
dateStart	[необязательный] Начальная дата диапазона поиска по времени создания (rfc3339, например, 2021-01-17T19:00:00.000Z).
dateEnd	[необязательный] Конечная дата диапазона поиска по времени создания (rfc3339, например, 2021-01-17T19:00:00.000Z).
updateDateStart	[необязательный] Начальная дата диапазона поиска по времени обновления (rfc3339, например, 2021-01-17T19:00:00.000Z).
updateDateEnd	[необязательный] Конечная дата диапазона поиска по времени обновления (rfc3339, например, 2021-01-17T19:00:00.000Z).
executionDateStart	[необязательный] Начальная дата диапазона поиска по времени завершения (rfc3339, например, 2021-01-17T19:00:00.000Z).
executionDateEnd	[необязательный] Конечная дата диапазона поиска по времени завершения (rfc3339, например, 2021-01-17T19:00:00.000Z).
skip	[необязательный] Количество операций в ответе, которое нужно пропустить.
limit	[необязательный] Количество операций, которое нужно получить.
output	[устарело] Расширенный формат вывода. 'e' - загрузка дополнительной информации (операции выдачи клиенту, договора), 't' - загрузка информации о тегах, 's' - загрузка суммарной информации о позициях. Для указания нескольких флагов стоит писать их слитно, например, output=se
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: orderPicking - операция отгрузки, по которой создан возврат agreement - договор, по которому выполнена отгрузка tags - теги posInfo - загрузка суммарной информации о позициях

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/get?userlogin=username&userpsw=md5pass&clietnId=5555&output=e&limit=10

Метод возвращает список операций возврата покупателя:

Поле	Описание
id	Идентификатор операции
number	Номер операции
createDate	Дата создания
executionDate	Дата завершения
creatorId	Идентификатор пользователя, создавшего опреацию
expertId	Идентификатор пользователя, назначенного в качестве эксперта
clientId	Идентификатор клиента
agreementId	Идентификатор договора с клиентом
orderPickingId	Идентификатор отгрузки
positionCount	Количество позиций в созданной операции
canceledPositionCount	Количество аннулированных позиций
tags	Список тегов, назначенных операции
externalId	Параметр для связи с внешними сервисами

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

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

Метод: GET

Возвращает список позиций операции возврата покупателя

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
opId	[необязательный] Идентификатор операции
opIds	[необязательный] Идентификаторы операций через запятую.
orderPickingGoodId	[необязательный] Идентификатор позиции отгрузки по выдаче клиенту.
orderPickingGoodIds	[необязательный] Идентификаторы позиций отгрузки через запятую.
executionDateStart	[необязательный] начальная дата диапазона поиска завершения позиции в формате rfc3339
executionDateEnd	[необязательный] конечная дата диапазона поиска завершения позиции в формате rfc3339
pickingIds	[необязательный] Идентификаторы операции отгрузки.
oldCoPositionIds	[необязательный] Идентификаторы позиции заказа через запятую.
clientId	[необязательный] Идентификатор клиента.
oldItemID	[необязательный] Идентификатор старой партии.
itemId	[необязательный] Числовой идентификатор партии.
tagIds	[необязательный] Идентификаторы тегов через запятую.
locId	[необязательный] Идентификатор места хранения.
status	[необязательный] Статус позиции. 1 - Новая 2 - В работе 3 - Отказ 4 - Завершено 5 - Возвращено клиенту 6 - Аннулировано 7 - Отклонено 8 - Ожидаем возврат товара
type	[необязательный] Тип возврата (1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт).
dateStart	[необязательный] Минимальная дата создания операции в формате по времени создания (rfc3339, например, 2021-01-17T19:00:00.000Z).
dateEnd	[необязательный] Максимальная дата создания операции в формате по времени создания rfc3339 (rfc3339, например, 2021-01-17T19:00:00.000Z).
updateDateStart	[необязательный] Начальная дата диапазона поиска по времени обновления (rfc3339, например, 2021-01-17T19:00:00.000Z).
updateDateEnd	[необязательный] Конечная дата диапазона поиска по времени обновления (rfc3339, например, 2021-01-17T19:00:00.000Z).
skip	[необязательный] Количество операций в ответе, которое нужно пропустить.
limit	[необязательный] Максимальное количество позиций, которое дожно быть возвращено в ответе.
sort	[необязательный] Как сортировать позиции: status - по статусу, createDate - по дате создания операции.
output	[необязательный] Расширенный формат вывода. 'e' - загрузка дополнительной информации (карточки товаров, партия, позиции и операции отгрузки, доступное количество для возврата), t - загрузка информации о тегах. Для указания нескольких флагов стоит писать их слитно, например, output=te
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: item - товар на складе product - товар из справочника location - место хранения orderPickingInfo - операция отгрузки; позиция отгрузки, связанная с возвратом; доступное для возврата количество tags - теги operationInfo - информация- Дополнительная информация. Воз об операции supplierReturnPos - связанный возврат поставщику (null, если такого нет)

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/getPositions?userlogin=username&userpsw=md5pass&opId=100&output=et

Метод возвращает список позиций операции возврата покупателя:

id	Идентификатор позиции
opId	Идентификатор операции
status	Статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара)
type	Тип возврата(1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
orderPickingGoodId	Идентификатор позиции отгрузки
oldItemId	Идентификатор партии, отгруженной по операции отгрузки
itemId	Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе")
locId	Идентификатор места хранения принятого товара
quantity	Количество
attrs	Список добавленных к позиции документов и изображений
pickingDate	Дата и время выдачи товара обратно клиенту
executionDate	Дата завершения позиции
comment	Комментарий
product	Карточка товара
orderPickingGood	Объект позиции отгрузки
orderPicking	Объект операции отгрузки
availableQuantity	Количество товара, доступное к возврату по позиции отгрузки
tags	Список тегов, назначенных позиции
externalId	Параметр для связи с внешними сервисами

Создание возврата покупателя

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

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderPickingId	[Обязательный] Идентификатор операции отгрузки из которой возвращается товар
createDate	[Необязательный] Дата и время создания отгрузки в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339), если не указано - используется текущая дата и время
positions	[Обязательный] Список позиций
externalId	[Необязательный] Параметр для связи с внешними сервисами

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

Поле	Описание
orderPickingPositionId	Идентификатор позиции отгрузки
quantity	Количество
type	Тип возврата(1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
comment	Комментарий
externalId	[Необязательный] Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/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	Количество товара, доступное к возврату по позиции отгрузки
externalId	Параметр для связи с внешними сервисами

Создание позиции возврата покупателя

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

Метод: POST

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

userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
opId	[обязательный] идентификатор операции возврата
orderPickingPositionId	[обязательный] идентификатор позиции отгрузки
quantity	[обязательный] количество к возврату
type	[обязательный] тип возврата(1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
comment	[обязательный] комментарий
externalId	[обязательный] Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/createPosition

Параметры POST

userlogin=username&userpsw=md5pass&opId=123&orderPickingPositionId=1234=&quantity=2&type=3&comment=Comment%20for%20position

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

Поле	Описание
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	Количество товара, доступное к возврату по позиции отгрузки
externalId	Параметр для связи с внешними сервисами

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

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

Метод: POST

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

userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positions	[обязательный] список позиций
customerComplaintId	[обязательный, если не указан customerComplaintId] ид операции возврата
customerComplaint	[обязательный, если не указан customerComplaint] данные для создания операции возврата
customComplaintFile	кастомный файл заявки на возврат в виде строки в формате base64

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

Поле	Описание
orderPickingGoodId	[обязательный] Идентификатор позиции отгрузки
quantity	[обязательный] Количество
type	[обязательный] Тип возврата(1-возврат, 2-отказ, 3-брак, 4-недовоз, 5-пересорт)
comment	[обязательный] Комментарий
attrs	приложенные файлы
externalId	[Необязательный] Параметр для связи с внешними сервисами

Где attrs содержит следующее:

docs	список приложенных к позиции документов
photos	список приложенных к позиции изображений

И docs, и photos содержат список объектов приложенных файлов следующего вида:

name	[обязательный] наименование файла
file	[обязательный] сам файл в виде base64-строки
description	описание файла

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

Поле	Описание
orderPickingId	[обязательный] Идентификатор операции отгрузки
creatorId	[обязательный] Идентификатор создателя возврата
expertId	Идентификатор эксперта
number	Номер операции возврата
externalId	[необязательный] Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/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]=comment&positions[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	Параметр для связи с внешними сервисами

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

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

Метод: POST

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

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[обязательный] идентификатор позиции возврата покупателя
quantity	[необязательный] количество
type	[необязательный] тип возврата
comment	[необязательный] комментарий
executionDate	[необязательный] дата и время выполнения, формат RFC3399, (можно изменять только если позиция находится в статусе "Завершен", status=4)

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/updatePosition

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&quantity=2&type=3&comment=Comment%20for%20position

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

Поле	Описание
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	Количество товара, доступное к возврату по позиции отгрузки
externalId	Параметр для связи с внешними сервисами

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

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

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[обязательный] идентификатор позиции возврата покупателя
status	[обязательный] статус позиции (1-новая, 2-в работе, 3-отказ, 4-завершёно, 5-возвращено клиенту, 6-аннулировано, 7-отклонено, 8-ожидаем возврат товара) Движение возврата

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/changeStatusPosition

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&status=8

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

Поле	Описание
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	Количество товара, доступное к возврату по позиции отгрузки
externalId	Параметр для связи с внешними сервисами

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

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

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id	[обязательный] идентификатор операции возврата покупателя
number	[обязательный если не задан expertId] уникальный номер операции
expertId	[обязательный если не задан number] идентификатор сотрудника-эксперта
customComplaintFile	[необязательный] - форма "Заявка на возврат", файл, передавать строкой в формате base64. Для удаления файла - указать пустое значение.
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: orderPicking - операция отгрузки, по которой создан возврат agreement - договор, по которому выполнена отгрузка posInfo - загрузка суммарной информации о позициях

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/update

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&number=123&expertId=111

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

Поле	Описание
id	Идентификатор операции
number	Номер операции
createDate	Дата создания
creatorId	Идентификатор пользователя, создавшего опреацию
expertId	Идентификатор пользователя, назначенного в качестве эксперта
clientId	Идентификатор клиента
agreementId	Идентификатор договора с клиентом
orderPickingId	Идентификатор отгрузки
orderPicking	Объект операции отгрузки
agreement	Объект договора
posInfo	Объект суммарной информации о позициях
externalId	Параметр для связи с внешними сервисами

Обновление файла в возврате покупателя

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

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
id^*	идентификатор операции возврата покупателя
customComplaintFile^*	форма "Заявка на возврат", файл, передавать строкой в формате base64. Для удаления файла - указать пустое значение.
fields	[необязательный] Расширенный формат вывода. Набор из следующих строк через запятую: orderPicking - операция отгрузки, по которой создан возврат agreement - договор, по которому выполнена отгрузка posInfo - загрузка суммарной информации о позициях

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

https://demo.public.api.abcp.ru/cp/ts/customerComplaints/update

Параметры POST

userlogin=username&userpsw=md5pass&id=1234

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

Поле	Описание
id	Идентификатор операции
number	Номер операции
createDate	Дата создания
creatorId	Идентификатор пользователя, создавшего опреацию
expertId	Идентификатор пользователя, назначенного в качестве эксперта
clientId	Идентификатор клиента
agreementId	Идентификатор договора с клиентом
orderPickingId	Идентификатор отгрузки
orderPicking	Объект операции отгрузки
data.customComplaintFile	Не пустое значение означает что для возврата загружена форма "Заявка на возврат"
agreement	Объект договора
posInfo	Объект суммарной информации о позициях
externalId	Параметр для связи с внешними сервисами

Возврат поставщику

Получение списка возвратов поставщику

Операция: GET /cp/ts/supplierReturns/operations/list

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
ids	[]uint	ID возвратов поставщику через запятую
creatorId	uint	Идентификатор пользователя, создавший возврат
supplierId	uint	Идентификатор контрагента
goodsReceiptId	uint	Идентификатор приемки
agreementIds	[]uint	Идентификаторы договоров через запятую
tagIds	[]uint	Идентификаторы тегов через запятую
sbisStatuses	[]string	Список статусов СБИС
dateStart	string	Минимальная дата создания в формате RFC3399
dateEnd	string	Максимальная дата создания в формате RFC3399
updateDateStart	string	Минимальная дата обновления в формате RFC3399
updateDateEnd	string	Максимальная дата обновления в формате RFC3399
skip	uint	Пропуск записей
limit	uint	Ограничение количества записей в выборке
fields	string	Дополнительная информация (значения через запятую)

Параметр fields

Параметр	Описание
goodsReceipt	информация по приемке
agreement	информация о договоре
tags	идентификаторы тегов

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/operations/list?userlogin=username&userpsw=md5pass

Метод возвращает набор объектов возвратов.

Получение сумм возвратов поставщику

Операция: GET /cp/ts/supplierReturns/operations/sum

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
creatorId	uint	Идентификатор пользователя, создавший возврат
supplierId	uint	Идентификатор контрагента
goodsReceiptId	uint	Идентификатор приемки
agreementIds	[]uint	Идентификаторы договоров через запятую
tagIds	[]uint	Идентификаторы тегов через запятую
sbisStatuses	[]string	Список статусов СБИС
dateStart	string	Минимальная дата создания в формате RFC3399
dateEnd	string	Максимальная дата создания в формате RFC3399
updateDateStart	string	Минимальная дата обновления в формате RFC3399
updateDateEnd	string	Максимальная дата обновления в формате RFC3399
skip	uint	Пропуск записей
limit	uint	Ограничение количества записей в выборке

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/operations/sum?userlogin=username&userpsw=md5pass

Метод возвращает объект сумм возвратов.

Просмотр объекта возврата поставщику

Операция: GET /cp/ts/supplierReturns/operations/get

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор возврата

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/operations/get?userlogin=username&userpsw=md5pass?id=1234

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

Создание возврата поставщику

Операция: POST /cp/ts/supplierReturns/operations/create

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
createDate	string	Дата создания в формате RFC3399. Если незаполнена, будет учтена текущая дата
creatorId	uint	ID сотрудника-создателя операции
goodsReceiptId^*	uint	Идентификатор приемки
externalId	string	Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/operations/create

Параметры POST

userlogin=username&userpsw=md5pass&creatorId=1234&goodsReceiptId=1234

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

Обновление возврата поставщику

Операция: POST /cp/ts/supplierReturns/operations/update

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор возврата
number	string	Номер возврата
fields	string	Дополнительная информация в выдаче объекта (значения через запятую)

Параметр fields

Параметр	Описание
goodsReceipt	информация по приемке
agreement	информация о договоре
tags	идентификаторы тегов

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/operations/update

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&number=someNumber&fields=goodsReceipt,tags

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

Удаление возврата поставщику

Операция: POST /cp/ts/supplierReturns/operations/delete

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор возврата

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/operations/delete

Параметры POST

userlogin=username&userpsw=md5pass&id=1234

Метод ничего не возвращает.

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

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
opId	uint	Идентификатор возврата
opIds	string	Идентификаторы возврата (через запятую)
status	uint8	Статус позиции. 1 - Новый 2 - Заявка отправлена 3 - Заявка подтверждена 4 - В работе 5 - Завершен 6 - Аннулирован 7 - Заявка отклонена 8 - Отказ (у поставщика) 9 - Отказ (получен)
type	uint8	Тип возврата
goodsReceiptPosIds	string	Идентификаторы позиций приемок (через запятую)
itemIds	string	Идентификаторы партий (через запятую)
supplierId	string	Идентификатор поставщика
goodsReceiptIds	string	Идентификаторы приемки (через запятую)
dateStart	string	Минимальная дата создания в формате RFC3399
dateEnd	string	Максимальная дата создания в формате RFC3399
updateDateStart	string	Минимальная дата обновления в формате RFC3399
updateDateEnd	string	Максимальная дата обновления в формате RFC3399
skip	uint	Пропуск записей
limit	uint	Ограничение количества записей в выборке
fields	string	Дополнительная информация (значения через запятую)

Параметр fields

Параметр	Описание
product	информация о товаре из справочника
item	информация по партии товара
location	расширяет список позиций возврата МХ
operationInfo	информация об операции возврата
tags	информация о тегах
goodsReceiptPos	информация о позициях приемки
availableQuantity	информация об остатках
customerComplaintPos	информация о возврата покупателю

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/list?userlogin=username&userpsw=md5pass

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

Получение сумм позиций возврата поставщику

Операция: GET /cp/ts/supplierReturns/positions/sum

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
opId	uint	Идентификатор возврата
status	uint8	Статус позиции. 1 - Новый 2 - Заявка отправлена 3 - Заявка подтверждена 4 - В работе 5 - Завершен 6 - Аннулирован 7 - Заявка отклонена 8 - Отказ (у поставщика) 9 - Отказ (получен)
type	uint8	Тип возврата
goodsReceiptPosIds	string	Идентификаторы позиций приемок (через запятую)
itemIds	string	Идентификаторы партий (через запятую)
supplierId	string	Идентификатор контрагента
goodsReceiptIds	string	Идентификаторы приемки (через запятую)
dateStart	string	Минимальная дата создания в формате RFC3399
dateEnd	string	Максимальная дата создания в формате RFC3399
updateDateStart	string	Минимальная дата обновления в формате RFC3399
updateDateEnd	string	Максимальная дата обновления в формате RFC3399
skip	uint	Пропуск записей
limit	uint	Ограничение количества записей в выборке
fields	string	Дополнительная информация (значения через запятую)

Параметр fields

Параметр	Описание
item	информация по партии товара
location	расширяет список позиций возврата МХ
operationInfo	информация об операции возврата
tags	информация о тегах
goodsReceiptPos	информация о позициях приемки
availableQuantity	информация об остатках
customerComplaintPos	информация о возврата покупателю

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/sum?userlogin=username&userpsw=md5pass

Метод возвращает набор объектов сумм позиций возврата.

Получение данных о количестве позиций, находящихся в не конечных статусах

Операция: GET /cp/ts/supplierReturns/positions/status

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/status?userlogin=username&userpsw=md5pass

Метод возвращает объект счетчиков позиций в не конечных статусах.

Просмотр объекта позиции возврата поставщику

Операция: GET /cp/ts/supplierReturns/positions/get

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор позиции

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/get?userlogin=username&userpsw=md5pass?id=1234

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

Создание позиций возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/createMultiple

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
opId^*	uint	Идентификатор возврата
posesData^*	[]posesData	Информация о позициях

Объект posesData

Параметр	Тип	Описание
type^*	uint8	Тип возврата
goodsReceiptPosId	uint	Идентификатор позиции приемки
locId^*	uint	Идентификатор МХ, где лежит товар для возврата
quantity^*	float64	Количество
customerComplaintPosId	uint	Идентификатор позиции возврата от клиента
itemId	uint	Идентификатор партии товара
comment	string	Комментарий
externalId	string	Параметр для связи с внешними сервисами

В запросе необходимо объявить минимум один из параметров customerComplaintPosId или itemId

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/createMultiple

Параметры POST

userlogin=username&userpsw=md5pass&type=1&goodsReceiptPosId=123&locId=123&quantity=2.0&itemId=123

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

Разделение позиции возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/split

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор позиции товара
quantity^*	float64	Количество
fields	string	Поля для загрузки в расширенной структуре (через запятую)

Параметр fields

Параметр	Описание
item	информация по партии товара
location	расширяет список позиций возврата МХ
operationInfo	информация об операции возврата
tags	информация о тегах
goodsReceiptPos	информация о позициях приемки
availableQuantity	информация об остатках
customerComplaintPos	информация о возврата покупателю

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/split

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&quantity=2.0

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

Обновление позиции возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/update

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	[обязательный] идентификатор позиции возврата поставщику
type	uint8	Тип возврата
locId	uint	МХ, где лежит товар для возврата
quantity	float64	Количество
comment	string	Комментарий к позиции
fields	string	Поля для загрузки в расширенной структуре (через запятую)
executionDate	datetime	Дата и время выполнения операции, формат rfc3339, изменение возможно только для позиции в конечном статусе, status=5 - завершен

Параметр fields

Параметр	Описание
item	информация по партии товара
location	расширяет список позиций возврата МХ
operationInfo	информация об операции возврата
tags	информация о тегах
goodsReceiptPos	информация о позициях приемки
availableQuantity	информация об остатках
customerComplaintPos	информация о возврата покупателю

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/update

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&type=2&quantity=2.0

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

Изменение статуса позиции возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/changeStatus

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор позиции
status	uint8	Статус позиции. 1 - Новый 2 - Заявка отправлена 3 - Заявка подтверждена 4 - В работе 5 - Завершен 6 - Аннулирован 7 - Заявка отклонена 8 - Отказ (у поставщика) 9 - Отказ (получен)
fields	string	Поля для загрузки в расширенной структуре (через запятую)

Параметр fields

Параметр	Описание
item	информация по партии товара
location	расширяет список позиций возврата МХ
operationInfo	информация об операции возврата
tags	информация о тегах
goodsReceiptPos	информация о позициях приемки
availableQuantity	информация об остатках
customerComplaintPos	информация о возврата покупателю

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/changeStatus

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&status=2

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

Создание атрибута позиции возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/attr/create

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор позиции
attr^*	Attribute	Объект атрибута

Объект Attrubute

Параметр	Тип	Описание
name^*	string	Название
file^*	string	Содержимое файла в кодировке Base64
creatorId	uint	Идентификатор инициатора
description	string	Описание

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/attr/create

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&attr[name]=договор&attr[file]=aGVsbG8gd29ybGQ=

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

Обновление атрибута позиции возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/attr/update

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор позиции
oldName^*	string	Прежнее название атрибута
newName^*	string	Новое название атрибута
description^*	string	Описание атрибута

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/attr/update

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&oldName=договор&newName=заявление&description=заявление+на+возврат

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

Удаление атрибута позиции возврата поставщику

Операция: POST /cp/ts/supplierReturns/positions/attr/delete

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	Идентификатор позиции
name^*	string	Название атрибута

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

https://demo.public.api.abcp.ru/cp/ts/supplierReturns/positions/attr/delete

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&name=договор

Метод ничего не возвращает.

Объект возврата поставщику

Параметр	Тип	Описание
id	uint	Идентификатор
number	string	Номер возврата
createDate	string	Дата создания
creatorId	uint	Идентификатор создателя возврата
supplierId	uint	Идентификатор контрагента
agreementId	uint	Идентификатор договора
goodsReceiptId	uint	Идентификатор приемки
sbisStatus	string	Статус СБИС
tags	[]uint	Теги
externalId	string	Параметр для связи с внешними сервисами

Объект сумм возвратов поставщикам

Параметр	Тип	Описание
positionsTotalSum	float64	сумма закупки (из позиции приемки) в валюте магазина
operationsCount	uint	количество возвратов
positionsCount	uint	количество позиций
goodsQuantity	uint	суммарное количество товара по позициям
countPositionsByStatus	positionsByStatus	кол-во позиций сгруппированных по статусу

Объект positionsByStatus

Параметр	Тип	Описание
new	uint	в статусе "Новый"
requestSent	uint	в статусе "Заявка отправлена"
requestAccepted	uint	в статусе "Заявка принята"
inWork	uint	в статусе "В работе"
finished	uint	в статусе "Завершен"
canceled	uint	в статусе "Аннулирован"
requestCanceled	uint	в статусе "Заявка отклонена"
supplierRejected	uint	в статусе "Отказ (у поставщика)"
supplierReturned	uint	в статусе "Отказ (получен)"

Объект позиции возврата поставщику

Параметр	Тип	Описание
id	uint	Идентификатор
opId	uint	Идентификатор операции (возврата)
status	uint8	Статус позиции. 1 - Новый 2 - Заявка отправлена 3 - Заявка подтверждена 4 - В работе 5 - Завершен 6 - Аннулирован 7 - Заявка отклонена 8 - Отказ (у поставщика) 9 - Отказ (получен)
type	uint8	Тип возврата
goodsReceiptPosId	uint\|null	Идентификатор позиции приемки
customerComplaintPosId	uint\|null	Идентификатор позиции возврата от клиента
itemId	uint\|null	Идентификатор партии товара
locId	uint\|null	Идентификатор МХ, где лежит товар для возврата
quantity	float64	Количество
attrs	[]SupplierReturnPositionAttrs	Дополнительные свойства: фотографии, описания, документы
issueDate	datetime\|null	Дата и время передачи товара от магазина поставщику
executionDate	datetime\|null	Дата и время выполнения
acceptanceBackDate	datetime\|null	Дата и время приемки товара на склад при передаче его от поставщика магазину
comment	datetime\|null	Комментарий к позиции
externalId	string	Параметр для связи с внешними сервисами

Объект SupplierReturnPositionAttrs

Параметр	Тип	Описание
name	string	Название
contentType	string	Тип контента
fileAPIName	string	Имя файла в fileAPI
description	string	Описание
creatorId	string	Идентификатор автора
uploadDate	datetime	Дата загрузки

Объект сумм позиций возврата поставщику

Параметр	Тип	Описание
positionsTotalSum	float64	Сумма закупки (из позиции приемки) в валюте магазина
positionsCount	uint	Количество позиций
goodsQuantity	uint	Суммарное количество товара по позициям
countPositionsByStatus	positionsByStatus	кол-во позиций сгруппированных по статусу

Объект positionsByStatus

Параметр	Тип	Описание
new	uint	В статусе "Новый"
requestSent	uint	В статусе "Заявка отправлена"
requestAccepted	uint	В статусе "Заявка принята"
inWork	uint	В статусе "В работе"
finished	uint	В статусе "Завершен"
canceled	uint	В статусе "Аннулирован"
requestCanceled	uint	В статусе "Заявка отклонена"
supplierRejected	uint	В статусе "Отказ (у поставщика)"
supplierReturned	uint	В статусе "Отказ (получен)"

Объект счетчиков позиций в не конечных статусах

Параметр	Тип	Описание
1	uint	В статусе "Новый"
2	uint	В статусе "Заявка отправлена"
3	uint	В статусе "Заявка принята"
4	uint	В статусе "В работе"
8	uint	В статусе "Отказ (у поставщика)"

Объект атрибута позиции возврата поставщику

Параметр	Тип	Описание
name	uint	Название
contentType	string	Тип контента
fileAPIName	string	Название файла в fileAPI
description	string	Описание
creatorId	uint	Идентификатор инициатора
uploadDate	datetime	Дата загрузки атрибута

Поставщики

Создание привязки контрагента к поставщику

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

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
distributorId^*	Идентификатор поставщика
supplierId^*	Идентификатор контрагента

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

https://demo.public.api.abcp.ru/cp/ts/distributorOwners/create

Параметры POST

userlogin=username&userpsw=md5pass&distributorId=482676&supplierId=10437627

Метод возвращает JSON-объект созданной привязки.

Получение привязанного контрагента

Операция: /cp/ts/distributorOwners

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
distributorId	Идентификатор поставщика

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

https://demo.public.api.abcp.ru/cp/ts/distributorOwners?userlogin=username&userpsw=md5pass&distributorId=11112

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

Поле	Описание
userId	Идентификатор контрагента
name	Полное имя контрагента
email	Адрес электронной почты
city	Город
mobile	Мобильный номер телефона

Удаление привязки контрагента к поставщику

Операция: /cp/ts/distributorOwners/delete

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
distributorId^*	Идентификатор поставщика
supplierId^*	Идентификатор контрагента

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

https://demo.public.api.abcp.ru/cp/ts/distributorOwners/delete

Параметры POST

userlogin=username&userpsw=md5pass&distributorId=482676&supplierId=10437627

Ответ не содержит данных.

Заказы клиентов

Административные операции для работы с заказами клиентов.
* - обязательный параметр

Создание заказа

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

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
number	номер заказа клиента, если не указан, то сформируется согласно шаблону номеров заказов, если указан, то проверяется на уникальность
clientId^*	идентификатор клиента
agreementId	идентификатор соглашения (договора)
createTime	rfc3339 - дата и время создания заказа, если не указан, заполняется автоматически, не может быть из будущего
managerId	идентификатор сотрудника, ответственного за заказ
fields	дополнительная информация, поля
externalId	Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/orders/create

Параметры POST

userlogin=username&userpsw=md5pass&agreementId=1002&managerId=33&fields=agreement

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

Создание заказа по позициям корзины

Операция: /cp/ts/orders/createByCart

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
number	номер заказа клиента, если не указан, то сформируется согласно шаблону номеров заказов, если указан, то проверяется на уникальность
clientId^*	идентификатор клиента
agreementId^*	идентификатор соглашения (договора)
createTime	rfc3339 - дата и время создания заказа, если не указан, заполняется автоматически, не может быть из будущего
managerId	идентификатор сотрудника, ответственного за заказ
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[meetData][employeePerson]	string - контактный сотрудник
delivery[meetData][employeeContact]	string - контакт сотрудника
delivery[meetData][resellerComment]	string - комментарий от магазина
delivery[timeInterval][startTime]	rfc3339 - время начала интервала доставки
delivery[timeInterval][endTime]	rfc3339 - время конца интервала доставки
locale	string - локаль для сохранения описаний товаров
fields	дополнительная информация, поля
externalId	Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/orders/createByCart

Параметры POST

userlogin=username&userpsw=md5pass&positions[0]=1001&positions[1]=1002&delivery[meetData][address]=ул.Пушкина дом Кукушкина 42&delivery[meetData][person]=Иванов Ануар

Метод возвращает массив заказов

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

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

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
number	номер заказа
agreementId	идентификатор соглашения
managerId	идентификатор менеджера
deliveryId	идентификатор доставки
message	комментарий к заказу или позиции заказа
dateStart	rfc3339 начальная дата диапазона поиска по дате создания заказа(обязательное, если задан dateEnd)
dateEnd	rfc3339 конечная дата диапазона поиска по дате создания заказа(обязательное, если задан dateStart)
updateDateStart	rfc3339 начальная дата диапазона поиска по дате обновления заказа
updateDateEnd	rfc3339 конечная дата диапазона поиска по дате обновления заказа
deadlineDateStart	rfc3339 начальная дата диапазона поиска по дате ожидаемой поставки позиций заказа
deadlineDateEnd	rfc3339 конечная дата диапазона поиска по дате ожидаемой поставки позиций заказа
assembledDateStart	rfc3339 начальная дата диапазона поиска по дате полной комплектации заказа
assembledDateEnd	rfc3339 конечная дата диапазона поиска по дате полной комплектации заказа
orderIds	идентификаторы заказов через запятую
productIds	идентификаторы карточек товаров через запятую
positionStatuses	статусы позиций заказов через запятую
skip	количество заказов в ответе, которое нужно пропустить
limit	максимальное количество заказов, которое должно быть возвращено в ответе

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

https://demo.public.api.abcp.ru/cp/ts/orders/list?userlogin=username&userpsw=md5pass&agreementId=256

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

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

Получение одного заказа

Операция: /cp/ts/orders/get

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	Идентификатор заказа.

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

https://demo.public.api.abcp.ru/cp/ts/orders/get?userlogin=username&userpsw=md5pass&orderId=123

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

Отказ от заказа

Операция: /cp/ts/orders/refuse

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	Идентификатор заказа

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

https://demo.public.api.abcp.ru/cp/ts/orders/refuse

Параметры POST

userlogin=username&userpsw=md5pass&orderId=1231

Метод не возвращает данные, при успешном выполнении операции.

Обновление заказа

Операция: /cp/ts/orders/update

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	числовой идентификатор заказа
number	номер заказа клиента, если не указан, то сформируется согласно шаблону номеров заказов, если указан, то проверяется на уникальность
clientId	идентификатор клиента
agreementId	идентификатор соглашения (договора)
managerId	идентификатор сотрудника, ответственного за заказ
fields	дополнительная информация, поля

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

https://demo.public.api.abcp.ru/cp/ts/orders/update

Параметры POST

userlogin=username&userpsw=md5pass&orderId=1002&number=newOrderNumber&fields=agreement

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

Объединение заказов

Операция: /cp/ts/orders/merge

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
mainOrderId^*	идентификатор главного заказа объединения
mergeOrdersIds	массив, идентификаторы остальных заказов объединения
fields	дополнительная информация, поля

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

https://demo.public.api.abcp.ru/cp/ts/orders/merge

Параметры POST

userlogin=username&userpsw=md5pass&mainOrderId=1002&mergeOrdersIds[]=1003

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

Разделение заказа

Операция: /cp/ts/orders/split

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	идентификатор заказа разделения
positionIds	массив, идентификаторы отделяемых позиций заказа
fields	дополнительная информация, поля

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

https://demo.public.api.abcp.ru/cp/ts/orders/split

Параметры POST

userlogin=username&userpsw=md5pass&orderId=1002&positionIds[]=3003&positionIds[]=3004

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

order	объект исходного заказа с полями
newOrder	объект нового заказа с полями

Изменение суммы заказа

Операция: /cp/ts/orders/reprice

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	идентификатор заказа клиента
newSum	новая сумма заказа
fields	дополнительная информация, поля

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

https://demo.public.api.abcp.ru/cp/ts/orders/reprice

Параметры POST

userlogin=username&userpsw=md5pass&orderId=1002&newSum=442.42

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

Сообщения по заказам

Создание сообщения

Операция: /cp/ts/orders/messages/create

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	идентификатор заказа клиента
message	текст сообщения
employeeId	идентификатор сотрудника (если не указано, то будет использоваться API-администратор)

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

https://demo.public.api.abcp.ru/cp/ts/orders/messages/create

Параметры POST

userlogin=username&userpsw=md5pass&orderId=1002&message=text for message

Метод возвращает объект сообщения

Получение одного сообщения

Операция: /cp/ts/orders/messages/get

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
messageId^*	идентификатор сообщения

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

https://demo.public.api.abcp.ru/cp/ts/orders/messages/get?userlogin=username&userpsw=md5pass&messageId=1002

Метод возвращает объект сообщения

Получение списка сообщений

Операция: /cp/ts/orders/messages/list

Метод: GET

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	идентификатор заказа
skip	количество сообщений в ответе, которое нужно пропустить
limit	максимальное количество сообщений в ответе

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

https://demo.public.api.abcp.ru/cp/ts/orders/messages/list?userlogin=username&userpsw=md5pass&orderId=1002&skip=3&limit=5

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

total	количество сообщений без учета параметров skip и limit
list	список сообщений

Редактирование сообщения

Операция: /cp/ts/orders/messages/update

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
messageId^*	идентификатор сообщения
message	текст сообщения

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

https://demo.public.api.abcp.ru/cp/ts/orders/messages/update

Параметры POST

userlogin=username&userpsw=md5pass&messageId=1002&message=the text

Метод возвращает объект сообщения

Удаление сообщения

Операция: /cp/ts/orders/messages/delete

Метод: POST

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
messageId^*	идентификатор сообщения

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

https://demo.public.api.abcp.ru/cp/ts/orders/messages/delete

Параметры POST

userlogin=username&userpsw=md5pass&messageId=1002

Метод не возвращает данных в случае успешного выполнения операции.

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

agreement	информация о соглашении
tags	теги заказов и их позиций
posInfo	информация о позициях
deliveries	получить карту операций доставки, связанных с позициями заказа, карта будет добавлена в элемент posInfo
amounts	возвращает fullAmount - полная стоимость заказа, unpaidAmount - суммарная неоплаченная стоимость позиций

Стандартный набор полей заказа

id	uint - уникальный идентификатор заказа клиента
number	uint - номер заказа клиента
clientId	uint - идентификатор клиента
agreementId	uint - идентификатор соглашения
managerId	uint - Идентификатор ответственного менеджера
createTime	datetime - Время создания
updateTime	datetime - Время изменения
data[clToResRate]	float64 - Курс между валютой магазина и валютой договора с клиентом
data[discountPercent]	Скидка (процент)
assembledDate	Дата полной комплектации заказа
externalId	Параметр для связи с внешними сервисами

Объект сообщения в заказе

id	уникальный идентификатор сообщения
orderId	идентификатор заказа клиента
employeeId	идентификатор сотрудника
date	datetime - дата и время
message	текст сообщения

Возможные значения для статусов позиций заказа

new - Новый
reservation - Бронь
finished - Подтверждён/Завершен
prepayment - Требуется предоплата
orderPicking - Отгрузка
delivery - Доставка
canceled - Аннулировано
supOrder - Заказ поставщику
supOrderCanceled - Заказ поставщику Отказ

Работа с Корзиной

Административные операции для работы с корзиной.
* - обязательный параметр

Добавление позиции в корзину

Операция: POST /cp/ts/cart/create

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId^*	идентификатор клиента
agreementId	идентификатор договора, если не указан, то используется активный договор с клиентом по умолчанию
brand^*	бренд
number^*	артикул товара
numberFix^*	"Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
itemId	идентификатор партии на складе
quantity^*	количество товара
distributorRouteId^*	идентификатор маршрута прайс-листа
itemKey^*	Код товара, полученный поиском search/articles

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

https://demo.public.api.abcp.ru/cp/ts/cart/create

Параметры POST

userlogin=username&userpsw=md5pass&clientId=1002&brand=Febi&number=01089&quantity=1&itemKey=###123

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

Обновление позиции в корзине

Операция: POST /cp/ts/cart/update

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	идентификатор позиции в корзине
clientId^*	идентификатор клиента
guestId	идентификатор гостя, обязательный, если не задан clientId
quantity^*	новое количество
sellPrice	цена продаже в валюте магазина
clToResRate	курс между валютой договора с клиентом и валютой магазина
clSellPrice	цена продаже в валюте договора с клиентом
availability	новое наличие в прайс-листе
packing	новая кратность в прайс-листе
deadline	новый срок поставки
deadlineMax	новый максимальный срок поставки

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

https://demo.public.api.abcp.ru/cp/ts/cart/update

Параметры POST

userlogin=username&userpsw=md5pass&clientId=1002&quantity=1

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

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

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

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId	идентификатор клиента
guestId	идентификатор гостя
positionIds	список идентификаторов позиций в корзине, через запятую
agreementId	идентификатор договора, если не указан, то используется активный договор с клиентом по умолчанию
skip	количество позиций корзины в ответе, которое нужно пропустить
limit	максимальное количество позиций корзины, которое должно быть возвращено в ответе

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

https://demo.public.api.abcp.ru/cp/ts/cart/list?userlogin=username&userpsw=md5pass&agreementId=1002&clientId=33&positionIds=123,321

Метод возвращает поля:

total	общее кол-во найденных позиций
list	список найденных позиций

Проверка наличия позиции в корзине

Операция: GET /cp/ts/cart/exist

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId^*	идентификатор клиента
agreementId^*	идентификатор договора
brand^*	бренд
numberFix^*	"Очищенный" артикул товара, содержащий только алфавитные и цифровые символы

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

https://demo.public.api.abcp.ru/cp/ts/cart/exist?userlogin=username&userpsw=md5pass&agreementId=1002&clientId=33&brand=Febi&numberFix=01089

Метод возвращает поля:

quantity - количество найденных позиций в корзине

Получение суммарной информации по позициям корзины

Операция: GET /cp/ts/cart/summary

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId^*	идентификатор клиента
guestId	идентификатор гостя, обязательный, если не задан clientId
agreementId	идентификатор договора, если не указан, то используется активный договор с клиентом по умолчанию

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

https://demo.public.api.abcp.ru/cp/ts/cart/summary?userlogin=username&userpsw=md5pass&agreementId=1002&clientId=33

Метод возвращает поля:

count	количество позиций в корзине
quantity	количество товаров в корзине
cost	сумма позиций в корзине

Очистка корзины

Операция: POST /cp/ts/cart/clear

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId^*	идентификатор клиента
guestId	идентификатор гостя, обязательный, если не задан clientId

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

https://demo.public.api.abcp.ru/cp/ts/cart/clear

Параметры POST

userlogin=username&userpsw=md5pass&clientId=1002

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

Удаление позиций корзины

Операция: POST /cp/ts/cart/deletePositions

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId^*	идентификатор клиента
guestId	идентификатор гостя, обязательный, если не задан clientId
positionIds^*	массив идентификаторов позиций

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

https://demo.public.api.abcp.ru/cp/ts/cart/deletePositions

Параметры POST

userlogin=username&userpsw=md5pass&clientId=1002&positionIds[]=1011&positionIds[]=1012

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

Передача позиций корзины гостя клиенту

Операция: POST /cp/ts/cart/transfer

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
clientId^*	идентификатор клиента
guestId^*	идентификатор гостя

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

https://demo.public.api.abcp.ru/cp/ts/cart/transfer

Параметры POST

userlogin=username&userpsw=md5pass&clientId=1002&guestId=4242

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

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

id	uint - уникальный идентификатор заказа клиента
clientId	uint - идентификатор клиента
agreementId	uint - идентификатор соглашения
guestId	string - идентификатор гостя
routeId	uint - идентификатор маршрута прайс-листа
brand	string - бренд товара
numberFix	string - "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
itemId	uint - идентификатор партии на складе
quantity	float - количество
sellPrice	float - цена одной единицы товара в валюте магазина
clSellPrice	float - цена одной позиции в валюте договора с клиентом
createDate	datetime - дата и время добавления позиции в корзину
updateDate	datetime - дата и время изменения позиции в корзине
data[number]	string - номер по формату в ответе от поставщика (из результата поиска)
data[description]	string - описание из результатов поиска
data[wearout]	uint - износ б/у
data[distributorId]	uint - идентификатор прайс-листа
data[goodCode]	string - код товара
data[supplierCode]	string - код поставщика
data[packing]	uint - кратность (количество товара в упаковке)
data[availability]	int - наличие у поставщика
data[distCurrency]	string - валюта прайс-листа (ISO код)
data[distPrice]	float64 - цена из прайс-листа в валюте прайс-листа
data[distBuyPrice]	float64 - цена закупки в валюте прайс-листа
data[distSellPrice]	float64 - цена продажи в валюте прайс-листа
data[distToResRate]	float64 - курс конвертации из валюты прайс-листа в валюту магазина
data[buyPrice]	float64 - цена закупки в валюте магазина
data[clToResRate]	float64 - float, Курс между валютой магазина и валютой договора с клиентом
data[deadline]	uint - срок поступления на склад в часах
data[deadlineMax]	uint - срок поступления на склад максимальный в часах
data[itemKey]	string - строка с зашифрованными данными из результата поиска (dsItemKey)
data[onlineData]	json string - данные полученные из WH Online во время поиска товара, содержит поля
data[onlineData][meta]	ассоциативный массив - дополнительные параметры от online-поставщика
data[onlineData][params]	ассоциативный массив строк - параметры, с которыми позиция была получена из WH Online

Позиции заказов клиентов

Административные операции для работы с позициями заказов клиентов.
* - обязательный параметр

Получение одной позиции

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

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	идентификатор позиции заказа
additionalInfo	string, доп. информация позиции, значения через запятую

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

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

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

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

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

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
brand	string, бренд товара, полное совпадение
message	string, комментарий к позиции
agreementId	uint, идентификатор соглашения
clientId	uint, идентификатор клиента
managerId	uint, идентификатор менеджера
noManagerAssigned	флаг, добавляющий в выборку позиции без назначенного менеджера; используется с managerId
deliveryId	uint, идентификатор операции доставки
dateStart	string, минимальная дата создания позиций заказов
dateEnd	string, максимальная дата создания позиций заказов
updateDateStart	string, минимальная дата обновления заказов
updateDateEnd	string, максимальная дата обновления заказов
deadlineDateStart	string, минимальная дата ожидаемая дата поставки на склад
deadlineDateEnd	string, максимальная дата ожидаемая дата поставки на склад
orderPickingDateStart	string, минимальная дата связанной отгрузки
orderPickingDateEnd	string, максимальная дата связанной отгрузки
orderPickingGoodIds	[]uint, идентификаторы позиций отгрузки
customerComplaintPositionIds	[]uint, идентификаторы позиций возврата
productIds	[]uint, идентификаторы карточек товаров
soPositionIds	[]uint, идентификаторы позиций заказов поставщикам
routeIds	[]uint, идентификаторы маршрутов
distributorIds	[]uint, идентификаторы прайс-листов
ids	[]uint, идентификаторы позиций заказов клиентов
orderIds	[]uint, идентификаторы заказов клиентов
statuses	[]string, список статусов позиций заказов
tagIds	[]uint, id тегов через запятую
skip	uint, смещение (по умолчанию 0)
limit	uint, ограничение по кол-ву заказов в выдаче
additionalInfo	Дополнительная информация о позициях (можно через запятую указать несколько): unpaidAmount - суммарная неоплаченная стоимость позиций; delivery - информация о доставке; product - информация о продукте. clientNote - информация о заметках клиентов к позициям

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

https://demo.public.api.abcp.ru/cp/ts/positions/list?userlogin=username&userpsw=md5pass&brand=Febi&dateStart=2022-05-29 14:20:00&productIds[]=142&productIds[]=143

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

Поле	Описание
total	число найденных позиций
list	список найденных позиций

Создание позиции

Операция: POST /cp/ts/positions/create

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
orderId^*	uint, идентификатор заказа клиента
clientId^*	uint, идентификатор клиента
routeId^*	uint, идентификатор маршрута прайс-листа
distributorId^*	uint, идентификатор прайс-листа
itemKey^*	string, код товара, полученный поиском search/articles
quantity^*	float, количество
sellPrice^*	float, цена продаже в валюте магазина
brand^*	string, бренд
numberFix^*	string, "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
number^*	string, номер по формату в ответе от поставщика (из результата поиска)
externalId	Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/positions/create

Параметры POST

userlogin=username&userpsw=md5pass&orderId=3342&clientId=1002&quantity=1&brand=Febi&itemKey=#$@#!$

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

Создание нескольких позиций и добавление их в новый или существующий заказ

Операция: POST /cp/ts/positions/createMultiple

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	MD5-хэш пароля API-администратора
positions^*	Список позиций. Параметры каждой позиции аналогичны параметрам операции создания позиции заказа.
newOrder^*	[обязательный если не указан existOrderId] Данные нового заказа. Параметры аналогичны операции создания заказа.
existOrderId^*	[обязательный если не указан newOrder] Идентификатор существующего заказа для добавления в него позиций.
fields	Расширенный формат вывода позиций заказа. Возможные значения.
orderFields	Расширенный формат вывода заказа. Возможные значения.

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

https://demo.public.api.abcp.ru/cp/ts/positions/createMultiple

Параметры POST

userlogin=username&userpsw=md5pass&newOrder[clientId]=123&newOrder[agreementId]=234&positions[0]routeId=111&positions[0]distributorId=222&....

Метод возвращает объект из двух полей: order - заказ, positions - позиции.

Обновление позиции

Операция: POST /cp/ts/positions/update

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	uint, идентификатор позиции заказа
routeId	uint, идентификатор маршрута прайс-листа
distributorId	uint, идентификатор прайс-листа
quantity	float, количество
sellPrice	float, цена продажи в валюте магазина
clToResRate	float, курс между валютой договора с клиентом и валютой магазина
clSellPrice	float, цена продаже в валюте договора с клиентом
priceDataSellPrice	float, стоимость товара при проценке
prepaymentAmount	float, сумма предоплаты, при 0 будет рассчитана автоматически
deadlineTime	string, срок поставки на склад в формате RFC3339
deadlineTimeMax	string, максимальный поставки на склад в формате RFC3339
clientRefusal	bool, признак желания клиента отказаться от покупки товара
deliveryId	uint, идентификатор операции доставки
status	string, статус позиции, Новый или Предоплата
clientNote	Заметка клиента для позиции заказа

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

https://demo.public.api.abcp.ru/cp/ts/positions/update

Параметры POST

userlogin=username&userpsw=md5pass&orderId=3342&quantity=1&deadlineTime=2022-05-31 14:20:00

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

Аннулирование позиции

Операция: POST /cp/ts/positions/cancel

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	uint, идентификатор позиции заказа

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

https://demo.public.api.abcp.ru/cp/ts/positions/cancel

Параметры POST

userlogin=username&userpsw=md5pass&positionId=3569

Метод возвращает позицию.

Массовое аннулирование позиций

Операция: POST /cp/ts/positions/massCancel

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionIds^*	string, идентификаторы позиций через запятую

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

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

Параметры POST

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

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

Массовая смена статуса позиций

Операция: POST /cp/ts/positions/changeStatus

Данным способом можно менять статусы только с "Новый" на "Предоплата" и наоборот.

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionIds^*	string, идентификатор позиций через запятую
status^*	string, принимает значения: new, prepayment

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

https://demo.public.api.abcp.ru/cp/ts/positions/changeStatus

Параметры POST

userlogin=username&userpsw=md5pass&positionIds=3569,3242&status=prepayment

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

Разделение позиции

Операция: POST /cp/ts/positions/split

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	uint, числовой идентификатор позиции заказа клиента
quantity^*	float, количество, которое требуется отделить

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

https://demo.public.api.abcp.ru/cp/ts/positions/split

Параметры POST

userlogin=username&userpsw=md5pass&positionId=3242&quantity=1

Метод возвращает поля:

position	обновлённая позиция заказа клиента
createdPosition	созданная позиция заказа клиента

Объединение позиций

Операция: POST /cp/ts/positions/merge

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
mainPositionId^*	uint, позиция, в которую будут объединены остальные позиции
mergePositionsIds^*	позиции через запятую, которые будут объединены в главную позицию

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

https://demo.public.api.abcp.ru/cp/ts/positions/merge

Параметры POST

userlogin=username&userpsw=md5pass&mainPositionId=3242&mergePositionsIds=3243

Метод возвращает объект обновлённой позиции заказа

Сообщения по позициям заказа

Получение списка сообщений

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

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	uint - числовой идентификатор позиции заказа клиента
skip	количество сообщений в ответе, которое нужно пропустить
limit	максимальное количество сообщений, которое должно быть возвращено в ответе

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

https://demo.public.api.abcp.ru/cp/ts/positions/message/list?positionId=112233

Метод возвращает набор полей:

total	количество без учета параметров skip и limit
list	массив из json-объектов сообщений

Получение одного сообщения

Операция: GET /cp/ts/positions/message/get

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
messageId^*	uint, числовой идентификатор сообщения

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

https://demo.public.api.abcp.ru/cp/ts/positions/message/get?messageId=112233

Метод возвращает объект сообщения

Создание сообщения

Операция: POST /cp/ts/positions/message/create

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
positionId^*	uint, идентификатор позиции
message^*	string, текст сообщения
employeeId	uint, идентификатор сотрудника
date	datetime, дата и время

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

https://demo.public.api.abcp.ru/cp/ts/positions/message/create

Параметры POST

userlogin=username&userpsw=md5pass&positionId=3242&date=2022-05-31 14:20:00&message=comment

Метод возвращает объект сообщения

Редактирование сообщения

Операция: POST /cp/ts/positions/message/update

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
messageId^*	uint, идентификатор сообщения
message^*	string, текст сообщения
employeeId	uint, идентификатор сотрудника

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

https://demo.public.api.abcp.ru/cp/ts/positions/message/update

Параметры POST

userlogin=username&userpsw=md5pass&messageId=3242&message=comment

Метод возвращает объект сообщения

Удаление сообщения

Операция: POST /cp/ts/positions/message/delete

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
messageId^*	uint, идентификатор сообщения

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

https://demo.public.api.abcp.ru/cp/ts/positions/message/delete

Параметры POST

userlogin=username&userpsw=md5pass&messageId=3242

Метод не возвращает данных

Набор полей сообщения позиции заказа

id	uint, уникальный идентификатор сообщения
positionId	uint, идентификатор позиции
employeeId	uint, идентификатор сотрудника
createDate	datetime, дата и время
message	string, текст сообщения

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

id	uint, идентификатор
orderId	uint, ID заказа
clientId	uint, ID контрагента
productId	uint, ID товара
status	string, Статус позиции
routeId	uint, ID маршрута
distributorId	uint, ID прайс-листа
itemId	uint, Идентификатор партии на складе
soPositionId	uint, Идентификатор позиции SO
deliveryId	uint, Идентификатор операции доставки
clientRefusal	Признак желания клиента отказаться от покупки товара
quantity	float, Количество
sellPrice	float, Цена одной единицы товара в валюте магазина
clSellPrice	float, Цена одной позиции в валюте договора с клиентом
prepaymentAmount	float, Сумма предоплаты в валюте договора с клиентом
createTime	datetime, Время создания
updateTime	datetime, Время изменения
deadlineTime	datetime, дата и время поставки товара на склад, вычисляется в момент создания createTime + deadline (часы)
deadlineTimeMax	datetime, дата и время поставки товара на склад, вычисляется в момент создания createTime + deadlineMax (часы)
data	доп. информация о товаре в корзине в формате JSON
data[clToResRate]	float, Курс между валютой магазина и валютой договора с клиентом
data[discountPercent]	float, Скидка (процент)
data[beforeCancel]	object, сохраненные значения колонок перед их очисткой во время аннулирования позиции
data[beforeCancel][itemId]	uint, Идентификатор партии на складе
data[beforeCancel][soPositionId]	uint, Идентификатор позиции SO
priceData	доп. информация о товаре из результатов поиска в формате JSON
priceData[brand]	string, Бренд (из корзины)
priceData[numberFix]	string, "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы (из корзины)
priceData[number]	string, номер по формату в ответе от поставщика (из результата поиска)
priceData[description]	string, описание
priceData[wearout]	uint, износ б/у
priceData[goodCode]	string, Код товара
priceData[supplierCode]	string, Код поставщика
priceData[packing]	uint, Кратность
priceData[availability]	int, Доступно
priceData[distCurrency]	string, Валюта прайс-листа (ISO код)
priceData[distPrice]	float, Цена из прайс-листа в валюте прайс-листа
priceData[distBuyPrice]	float, Цена закупки в валюте прайс-листа
priceData[distSellPrice]	float, Цена продажи в валюте прайс-листа
priceData[distToResRate]	float, Курс конвертации из валюты прайс-листа в валюту магазина
priceData[buyPrice]	float, Цена закупки в валюте магазина
priceData[sellPrice]	float, Стоимость товара при проценке
priceData[deadline]	uint, Срок поступления на склад в часах (из корзины)
priceData[deadlineMax]	uint, Срок поступления на склад максимальный в часах (из корзины)
priceData[itemKey]	string, Зашифрованная информация из результата поиска
priceData[onlineData]	object, Доп. инфа из прайс-листа (обычно, онлайн)
priceData[onlineData][meta]	object, дополнительные параметры от online-поставщика
priceData[onlineData][params]	object, параметры, с которыми позиция была получена со склада
delivery	object, информация о доставке (*если использовался additionalInfo=delivery при получении позиции)
product	object, информация о продукте (*если использовался additionalInfo=product при получении позиции)
unpaidAmount	float, суммарная неоплаченная стоимость позиций (*если использовался additionalInfo=unpaidAmount при получении позиции)
externalId	Параметр для связи с внешними сервисами

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

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

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

reserv	информация о резервировании товара из партии на складе
product	информация о товаре из справочника
orderPicking	информация об отгрузке и её позиции
customerComplaintPoses	информация о позициях возврата от клиента
supplierOrder	информация о заказе и позиции заказа поставщику
grPosition	информация о связанной с партией позицией приёмки
order	сокращенная информация о заказе клиента
delivery	информация об операции доставки
tags	теги
unpaidAmount	сумма, которую должен уплатить клиент в зависимости от статуса позиции и точки возникновения долга - либо предоплата, либо оставшаяся сумма заказа/отгрузки
clientNote	Заметка клиента для позиции заказа

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

id	uint, идентификатор
contractorId	uint, ID клиента
creatorId	uint, ID сотрудника-создателя операции
agreementId	uint, ID договора
methodId	uint, ID способа доставки
status	string, состояние
trackNumber	string, номер для отслеживания
createDate	datetime, дата создания
startTime	datetime, начало интервала доставки
endTime	datetime, конец интервала доставки
price	float, цена в валюте магазина
clToResRate	float, курс между валютой магазина и валютой договора
clPrice	float, цена в валюте договра с клиентом
volume	float, суммарный объем
data	object, дополнительные сведения в сериализованном виде
data[maxSize]	float, максимальный размер в мм
data[maxSizesSum]	float, максимальная сумма измерений товара в мм
data[weight]	float, суммарная масса
data[contractorInfo]	object - информация об адресате
data[contractorInfo][address]	string, Полный адрес
data[contractorInfo][comment]	string, дополнительная информация
data[contractorInfo][contact]	string, телефон для связи
data[contractorInfo][person]	string, контактное лицо
data[contractorInfo][employeePerson]	string, имя сотрудника
data[contractorInfo][employeeContact]	string, телефон сотрудника
data[contractorInfo][resellerComment]	string, комментарий о месте доставки от магазина
data[contractorInfo][officeId]	uint, офис самовывоза

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

id	uint, уникальный идентификатор товара в справочнике
brand	string, бренд товара
number	string, артикул товара
numberFix	string, "Очищенный" артикул товара, содержащий только алфавитные и цифровые символы
code	string, код товара в системе учета реселлера
customsCode	string, таможенный код товара
brandGroup	string, группа товара от производителя
unitId	uint, ссылка на единицу измерения
packing	uint, кратность
priceup	float, наценка на товар в процентах
description	локализованная строка - описание товара
extDescription	локализованная строка - расширенное описание товара
shelfLife	int, срок годности товара в днях
forSale	bool, в продаже (да/нет)
availabilityNorm	float, норма наличия
orderPoint	uint, процент нормы наличия (при котором нужно заказывать товар)
createdTime	datetime, время создания записи
updateTime	datetime, время обновления записи
attrs	json string, дополнительный набор атрибутов в json-формате
attrs[weight]	float, вес товара
attrs[volume]	float, объем товара
attrs[length]	uint, длина в мм
attrs[width]	uint, ширина в мм
attrs[height]	uint, высота в мм
attrs[excise]	string, акциз
attrs[isDelete]	bool, признак логического удаления

История добавления, изменения, удаления данных

Административная операция для для получения истории изменения данных в модуле складского учёта. Получить информацию можно только за последние 180 дней.
* - обязательный параметр

Получение списка действий

Операция: GET /cp/ts/logs/read

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

Параметр	Описание
userlogin^*	Имя API-администратора
userpsw^*	md5-хэш пароля API-администратора
dateStart^*	Дата начала диапазона поиска в формате RFC3339
dateEnd^*	Дата конца диапазона поиска в формате RFC3339
type^*	тип требуемых записей. Возможные значения: all - записи всех типов. Дополнительные фильтры не применяются. clientOrder - заказы клиентов clientOrderPosition - позиции заказов клиентов orderPicking - операции отгрузки orderPickingPosition - позиции отгрузки customerComplaintPosition - позиции возвратов от покупателей delivery - доставки package - упаковки goodsReceipt - операции приёмки goodsReceiptPosition - позиции приёмки payment - платежи productHandling - операции перемещения productHandlingPosition - позиции перемещения supplierOrder - заказы поставщикам supplierOrderPosition - позиции заказов поставщикам supplierReturnPosition - позиции возвратов поставщикам
limit^*	Требуемое количество записей. Максимальное значение - 1000.
offset	Количество записей, которые нужно пропустить
employeeIds	идентификаторы сотрудников, осуществивших действие
ips	ip-адреса пользователей, осуществивших действие
locations	Места внесения изменений. Возможные значения: service - автоматическое изменение данных public-api - запрос был выполнен cp - панель управления site - сайт

Дополнительные фильтры заказов клиентов

Параметр	Описание
orderIds	Идентификаторы заказов
clientIds	Идентификаторы клиента
agreementIds	Идентификаторы договора
events	Типы событий. Возможные значения: create - создание update - обновление split - разделение заказа merge - объединение заказов reprice - изменение цены

Дополнительные фильтры позиций заказов клиентов

Параметр	Описание
positionIds	Идентификаторы позиций
orderIds	Идентификаторы заказов
clientIds	Идентификаторы клиентов
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса split - разделение reservationCreate - создание бронирования reservationDelete - уделение бронирования orderPickingPosCreate - создание позиции отгрузки supplierOrderPosCreate - создание позиции заказа поставщику prepaymentTake - изменение статуса с предоплата на новый prepaymentReturn - изменение статуса с новый на предоплата clientRefusalSet - отказ clientRefusalRemove - отмена отказа

Дополнительные фильтры операций отгрузки

Параметр	Описание
orderPickingGoodIds	Идентификаторы операций отгрузки
clientIds	Идентификаторы клиентов
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса

Дополнительные фильтры позиций отгрузки

Параметр	Описание
positionIds	Идентификаторы позиций
orderPickingGoodIds	Идентификаторы операций отгрузки
events	Типы событий. Возможные значения: create - создание update - изменение split - разделение delete - удаление

Дополнительные фильтры позиций возвратов от покупателей

Параметр	Описание
positionIds	Идентификаторы позиций
customerComplaintIds	Идентификаторы операций возвратов
clientIds	Идентификаторы клиентов
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса delete - удаление

Дополнительные фильтры операций доставки

Параметр	Описание
deliveryIds	Идентификаторы операций доставки
clientIds	Идентификаторы клиентов
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса coPositionAdd - добавление позиции заказа coPositionRemove - удаление позиции заказа

Дополнительные фильтры упаковки

Параметр	Описание
packageIds	Идентификаторы упаковок
deliveryIds	Идентификаторы операций доставки
events	Типы событий. Возможные значения: create - создание update - изменение delete - удаление

Дополнительные фильтры операций приёмки

Параметр	Описание
goodsReceiptIds	Идентификаторы операций приёмки
supplierIds	Идентификаторы поставщиков
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса delete - удаление

Дополнительные фильтры позиций приёмки

Параметр	Описание
positionIds	Идентификаторы позиций
goodsReceiptIds	Идентификаторы операций приёмки
events	Типы событий. Возможные значения: create - создание update - изменение delete - удаление

Дополнительные фильтры платежей

Параметр	Описание
paymentIds	Идентификаторы платежей
contractorIds	Идентификаторы контрагентов
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса

Дополнительные фильтры операций перемещения

Параметр	Описание
productHandlingIds	Идентификаторы операций перемещения
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса delete - удаление

Дополнительные фильтры позиций перемещения

Параметр	Описание
positionIds	Идентификаторы позиций
productHandlingIds	Идентификаторы операций перемещения
events	Типы событий. Возможные значения: create - создание update - изменение delete - удаление

Дополнительные фильтры заказов поставщикам

Параметр	Описание
orderIds	Идентификаторы заказов поставщикам
supplierIds	Идентификаторы поставщиков
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение send - отправка delete - удаление

Дополнительные фильтры позиций заказов поставщикам

Параметр	Описание
positionIds	Идентификаторы позиций
orderIds	Идентификаторы заказов поставщикам
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса split - разделение syncEnable - включение синхронизации syncDisable - отключение синхронизации delete - удаление

Дополнительные фильтры позиций возвратов поставщикам

Параметр	Описание
positionIds	Идентификаторы позиций
supplierReturnIds	Идентификаторы операций возвратов поставщикам
supplierIds	Идентификаторы поставщиков
agreementIds	Идентификаторы договоров
events	Типы событий. Возможные значения: create - создание update - изменение statusChange - изменение статуса

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

https://demo.public.api.abcp.ru/cp/ts/logs/read

Параметры get
userlogin=username&userpsw=md5pass&dateStart=2022-05-01T00:00:00&dateEnd=2022-05-25T23:59:59&type=clientOrder&orderIds[]=123&orderIds[]=124&events[]=create&events[]=update&events[]=merge&limit=100

Метод возвращает объекты записей истории действий

Операции приемки

fields приёмки

Во все операции, возвращающие объект приёмки, можно передать дополнительный параметр fields, по которому объект приёмки будет дополнен соответствующей информацией. Несколько параметров необходимо указывать через запятую.

Значение	Описание
agreement	информация о договоре с поставщиком
tags	теги
posInfo	суммарная информация о позициях

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

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

Метод: POST

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

Место хранения указывается в панели управления в разделе Настройки склада -> Операции -> Приемка.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
positions	список позиций
supplierId	Идентификатор контрагента, имеющего активный договор типа "поставка на склад"
agreementId	[необязательный] Идентификатор активного договора поставки. Если не передан, то будет задан договор с признаком "по умолчанию"
supNumber	[необязательный] номер отгрузки поставщика
supShipmentDate	[необязательный] дата и время отгрузки поставщика в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС
createDate	[необязательный] дата и время создания отгрузки в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339), если не указано - используется текущая дата и время
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/cp/ts/goodReceipts/create

Параметры POST
userlogin=username&userpsw=md5pass&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	Идентификатор созданной приёмки

Получение списка операций приёмка

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

Метод: GET

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
limit	[необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение.
skip	[необязательный] количество операций в ответе, которое нужно пропустить
auto	[необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число)
creatorId	[необязательный] идентификатор сотрудника-создателя
workerId	[необязательный] идентификатор сотрудника-исполнителя
agreementId	[необязательный] идентификатор договора
statuses	[необязательный] статусы через запятую (1 - новая, 2 - в работе, 3 - завершена)
number	[необязательный] номер операций
ids	[необязательный] идентификаторы операций через запятую
isDelete	[необязательный] при значении равном 1, будут отобраны только удаленные приемки
dateStart	[необязательный] начальная дата диапазона поиска по времени создания в формате rfc3339
dateEnd	[необязательный] конечная дата диапазона поиска по времени создания в формате rfc3339
updateDateStart	[необязательный] начальная дата диапазона поиска по времени обновления в формате rfc3339
updateDateEnd	[необязательный] конечная дата диапазона поиска по времени обновления в формате rfc3339
supShipmentDateStart	[необязательный] начальная дата диапазона поиска отгрузки поставщика в формате rfc3339
supShipmentDateEnd	[необязательный] конечная дата диапазона поиска отгрузки поставщика в формате rfc3339
supNumber	[необязательный] номер отгрузки поставщика

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/get?userlogin=username&userpsw=md5pass&limit=30&statuses=3

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

Поле	Описание
id	Идентификатор операции приёмки
number	Номер операции
createDate	Дата создания операции
status	Статус
creatorId	Идентификатор сотрудника-создателя
workerId	Идентификатор сотрудника-исполнителя
isDelete	Признак удаления
supplierId	Идентификатор поставщика
agreementId	Идентификатор соглашения
supNumber	Номер отгрузки поставщика
supShipmentDate	Дата отгрузки поставщика
buyAmount	Сумма приёмки в валюте магазина
supBuyAmount	Сумма приёмки в валюте договора
positionsCount	Количество позиций в операции
sumQuantity	Количество товаров в операции
agreement	Договор
supplier	Поставщик
externalId	Параметр для связи с внешними сервисами

Получение списка позиций приёмки

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

Метод: GET

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
opId	[обязательный, если не заполнен opIds] идентификатор операции
opIds	[обязательный, если не заполнен opId] идентификаторы операции через запятую
limit	[необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение.
skip	[необязательный] количество операций в ответе, которое нужно пропустить
productId	[необязательный] идентификатор товара справочника
updateDateStart	[необязательный] начальная дата диапазона поиска по времени обновления в формате rfc3339
updateDateEnd	[необязательный] конечная дата диапазона поиска по времени обновления в формате rfc3339
auto	[необязательный] автоопределяемое поле

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/getPositions?userlogin=username&userpsw=md5pass&limit=30&opId=3

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

Поле	Описание
id	Идентификатор позиции
opId	Идентификатор операции приёмки
productId	Идентификатора товара в справочнике
quantity	Количество
supBuyPrice	Цена закупки в валюте договора
supToResRate	Курс валюты магазина к валюте договора
buyPrice	Цена закупки в валюте магазина
sellPrice	Цена продажи
manufacturerCountry	Страна производитель товара
warrantyPeriod	Гарантийный период в днях
returnPeriod	Срок возврата
attrs	Дополнительные параметры(штрихкоды, комментарий, описание партии)
data	Дополнительные данные о связях позиции приёмки с заказами покупателя и поставщику
locId	Идентификатор места хранения
product	Карточка товара
externalId	Параметр для связи с внешними сервисами

Операция изменения приёмки

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор операции приёмки
supNumber	[необязательный] номер отгрузки поставщика
supShipmentDate	[необязательный] дата и время отгрузки поставщика в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/update

Параметры POST

userlogin=username&userpsw=md5pass&id=12&supNumber=5555&supShipmentDate=2021-05-27 10:27:30

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

Поле	Описание
id	Идентификатор операции приёмки
number	Номер операции
createDate	Дата создания операции
status	Статус
creatorId	Идентификатор сотрудника-создателя
workerId	Идентификатор сотрудника-исполнителя
isDelete	Признак удаления
supplierId	Идентификатор поставщика
agreementId	Идентификатор соглашения
supNumber	Номер отгрузки поставщика
supShipmentDate	Дата отгрузки поставщика
buyAmount	Сумма приёмки в валюте магазина
supBuyAmount	Сумма приёмки в валюте договора
positionsCount	Количество позиций в операции
sumQuantity	Количество товаров в операции
agreement	Договор
supplier	Поставщик

Операция изменения статуса приёмки

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор операции приёмки
status	id нового статуса приёмки

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/changeStatus

Параметры POST

userlogin=username&userpsw=md5pass&id=1&status=2

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

Поле	Описание
createItems	Значение будет null

При этом, если для параметра status передано значение 3 (приемка завершена), то метод вернет список id позиций приемки в формате - id позиции приемки : id партии

Операция удаления приёмки

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор операции приёмки

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/delete

Параметры POST

userlogin=username&userpsw=md5pass&id=1

Операции позиций приемки

fields позиции приёмки

Во все операции, возвращающие объект позиции приёмки, можно передать дополнительный параметр fields, по которому объект позиции приёмки будет дополнен соответствующей информацией. Несколько параметров необходимо указывать через запятую.

Значение	Описание
product	информация о товаре
location	информация о месте хранения
item	информация о партии
tags	теги
operationInfo	краткая информация об операции приёмки

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

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
opId	идентификатор приёмки
locId	[необязательный] идентификатор места хранения
productId	идентификатор товара в справочнике. Необязательный, если переданы brand и number
brand	Название производителя.
number	Номер детали (код производителя)
quantity	Количество
supBuyPrice	Цена позиции в валюте поставщика
manufacturerCountry	[необязательный] Страна производитель - три английские буквы: RUS - Россия, CNH - Китай, DEU - Германия и т.д. ИЛИ цифровой код страны (643 - Россия, 156 - Китай, 276 - Германия)
gtd	[необязательный] Номер ГТД
warrantyPeriod	[необязательный] Срок гарантийного обслуживания с момента продажи в днях
returnPeriod	[необязательный] Срок гарантированного возврата в днях
barcodes	[необязательный] Штрихкоды разделённые пробелами
comment	[необязательный] Комментарий
descr	[необязательный] Описание будущей партии
soPositionId	[необязательный] Идентификатор позиции заказа поставщику, на основании которой была создана позиция приемки
soQuantity	[необязательный] Ожидаемое кол-во товара
oldOrderPositionId	[необязательный] Идентификатор позиции старого заказа, на основании которой была создана позиция приемки. Используется при печати стикера приёмки для заполнения информации о заказе клиента.
wearout	[необязательный] Показатель состояния износа товара (б/у) 0 - новый товар, 10 - отличное, 30 - хорошее, 50 - удовлетворительное, 70 - под восстановление, 90 - ремонтный набор.
externalId	[необязательный] Параметр для связи с внешними сервисами

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/createPosition

Параметры POST

userlogin=username&userpsw=md5pass&brand=febi&number=01089&quantity=3&supBuyPrice=100&manufacturerCountry=rus&gtd=123123&warrantyPeriod=30&returnPeriod=14&barcodes=4027816010666%202053000000666&expectedQuantity=7.4&soPositionId=123456&oldOrderPositionId=3832215

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

Поле	Описание
id	Идентификатор созданной позиции приёмки

Операция удаления позиции приёмки

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор позиции приёмки

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/deletePosition

Параметры POST

userlogin=username&userpsw=md5pass&id=1

Операция получения позиции приёмки

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

Метод: GET

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор позиции приёмки

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/getPosition

Параметры GET
userlogin=username&userpsw=md5pass&id=1

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

Поле	Описание
id	Идентификатор позиции
opId	Идентификатор операции приёмки
productId	Идентификатора товара в справочнике
quantity	Количество
supBuyPrice	Цена закупки в валюте договора
supToResRate	Курс валюты магазина к валюте договора
buyPrice	Цена закупки в валюте магазина
sellPrice	Цена продажи
manufacturerCountry	Страна производитель товара
warrantyPeriod	Гарантийный период в днях
returnPeriod	Срок возврата
attrs	Дополнительные параметры(штрихкоды, комментарий, описание партии)
data	Дополнительные данные о связях позиции приёмки с заказами покупателя и поставщику, ожидаемом количестве и износе(б/у).
locId	Идентификатор места хранения
externalId	Параметр для связи с внешними сервисами
product	Карточка товара

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

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
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 - ремонтный набор.

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/updatePosition

Параметры POST

userlogin=username&userpsw=md5pass&brand=febi&number=01089&quantity=3&supBuyPrice=100&manufacturerCountry=rus&gtd=123123&warrantyPeriod=30&returnPeriod=14&barcodes=4027816010666%202053000000666&expectedQuantity=7.4&soPositionId=123456&oldOrderPositionId=3832215

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

Поле	Описание
id	Идентификатор позиции
opId	Идентификатор операции приёмки
productId	Идентификатора товара в справочнике
quantity	Количество
supBuyPrice	Цена закупки в валюте договора
supToResRate	Курс валюты магазина к валюте договора
buyPrice	Цена закупки в валюте магазина
sellPrice	Цена продажи
manufacturerCountry	Страна производитель товара
warrantyPeriod	Гарантийный период в днях
returnPeriod	Срок возврата
attrs	Дополнительные параметры(штрихкоды, комментарий, описание партии)
data	Дополнительные данные о связях позиции приёмки с заказами покупателя и поставщику
locId	Идентификатор места хранения
product	Карточка товара

Добавление изображения к позиции с износом (б/у)

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор позиции приёмки
buImage	массив данных вида [ "creatorId": 123, "files": [ "содержимое файла1 в кодировке Base64", "содержимое файла2 в кодировке Base64" ] ]

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/createPositionBuImage

Параметры POST

userlogin=username&userpsw=md5pass&id=123&buImage[files][]=base64file1&buImage[files][]=base64file2

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

Поле	Описание
publicName	url загруженного изображения
publicPreviewName	url предпросмотра загруженного изображения
imageAPIName	имя файла
creatorId	ид сотрудника
uploadDate	дата загрузки

Удаление изображения позиции с износом (б/у)

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	Идентификатор позиции приёмки
name	имя ранее загруженного файла

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

https://demo.public.api.abcp.ru/cp/ts/goodReceipts/deletePositionBuImage

Параметры POST

userlogin=username&userpsw=md5pass&id=123&name=fileName.png

Метод ничего не возвращает

Операции списания

fields списания

Во все операции, возвращающие объект списания, можно передать дополнительный параметр fields, по которому объект списания будет дополнен соответствующей информацией. Несколько параметров необходимо указывать через запятую.

Значение	Описание
tags	Информация о тегах
posInfo	Суммарная информация о позициях

Операция создания списания

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

Метод: POST

Создаёт операцию списания без позиций. Значение поля number генерируется автоматически. Можно изменить после создания списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
createDate	[Необязательный] Дата и время создания списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339), если не указано - используется текущая дата и время
creatorId	[Обязательный] Идентификатор сотрудника-создателя
workerId	[Обязательный] Идентификатор сотрудника-исполнителя
legalPersonId	[Обязательный] ID юридического лица, для которого списываются товары

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/create

Параметры POST
userlogin=username&userpsw=md5pass&creatorId=52467&workerId=52467&legalPerson=33422

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

Получение списка операций списания

Операция: /cp/ts/stockRemoval/list

Метод: GET

Возвращает массив операций списания, отобранных с учетом указанных в запросе фильтров.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
numbers	[Необязательный] Номера операций списания через запятую
ids	[Необязательный] Идентификаторы операций списаний через запятую
workerIds	[Необязательный] Список идентификаторов сотрудников-исполнителей через запятую
creatorIds	[Необязательный] Список идентификаторов сотрудников-создателей через запятую
statuses	[Необязательный] Массив статусов (new - Новое, inProgress - В работе, completed - Завершено, canceled - Аннулировано)
createDateStart	[Необязательный] Минимальная дата создания в формате RFC3399
createDateEnd	[Необязательный] Максимальная дата создания в формате RFC3399
updateDateStart	[Необязательный] Минимальная дата обновления в формате RFC3399
updateDateEnd	[Необязательный] Максимальная дата обновления в формате RFC3399
executionDateStart	[Необязательный] Минимальная дата завершения в формате RFC3399
executionDateEnd	[Необязательный] Максимальная дата завершения в формате RFC3399
productNumber	[Необязательный] Артикул товара
productBrand	[Необязательный] Бренд товара
productDescription	[Необязательный] Описание товара
productCode	[Необязательный] Код товара
gtd	[Необязательный] ГТД партии
tagIds	[Необязательный] Теги позиции или операции через запятую
positionTypes	[Необязательный] Список типов списания позиций через запятую
skip	[Необязательный] Количество операций в ответе, которое нужно пропустить. По умолчанию 0
limit	[Необязательный] Максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение - 1000. Если не указан, будет установлено максимально возможное значение

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/list?userlogin=username&userpsw=md5pass&ids=14,16&statuses[0]=new&statuses[1]=completed&fields=posInfo

Метод возвращает массив объектов списания.

Операция изменения списания

Операция: /cp/ts/stockRemoval/update

Метод: POST

Изменение существующей операции списания. Передаем только те параметры, которые хотим поменять.

В статусе Аннулировано ничего менять уже нельзя.

В статусе Завершено можно менять только дату завершения списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] Идентификатор операции списания
number	[Необязательный] Номер операции списания
createDate	[Необязательный] Дата и время создания списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339)
executionDate	[Необязательный] Дата и время завершения списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339)
creatorId	[Необязательный] Идентификатор сотрудника-создателя
workerId	[Необязательный] Идентификатор сотрудника-исполнителя
legalPersonId	[Необязательный] ID юридического лица, для которого списываются товары (можно изменить только в статусе Новый, если нет позиций)

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/update

Параметры POST
userlogin=username&userpsw=md5pass&id=14&workerId=23114

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

Операция изменения статуса списания

Операция: /cp/ts/stockRemoval/changeStatus

Метод: POST

Изменение статуса операции списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] Идентификатор операции списания, для которой меняем статус
status	[Обязательный] Идентификатор нового статуса
force	[Необязательный] bool, параметр принудительного удаления позиций операции списания при смене статуса на “Аннулировано”. По умолчанию - false

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/changeStatus

Параметры POST
userlogin=username&userpsw=md5pass&id=14&status=canceled&force=true

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

Операции позиций списания

fields позиций списания

Во все операции, возвращающие объект позиций списания, можно передать дополнительный параметр fields, по которому объект позиции списания будет дополнен соответствующей информацией. Несколько параметров необходимо указывать через запятую.

Значение	Описание
item	Информация о партии
location	Информация о месте хранения
operationInfo	Информация об операции
tags	Информация о тегах
product	Информация о товаре
grPosition	Информация о позиции приемки
itemLocation	Информация о партии товара на складе

Операция пакетного создания позиций списания

Операция: /cp/ts/stockRemoval/createPositions

Метод: POST

Создание позиций списания в операции (с возможностью создания новой операции).

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
operationId	ID операции списания для добавления позиций. Необязательный, если указаны данные для создания новой операции
operation	Данные для создания операции списания и добавления в нее позиций. Необязательный, если указан operationId существующей операции
operation[createDate]	[Необязательный] Дата и время создания списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339), если не указано - используется текущая дата и время
operation[creatorId]	[Обязательный] Идентификатор сотрудника-создателя
operation[workerId]	[Обязательный] Идентификатор сотрудника-исполнителя
positions	Массив данных для создания позиций списания
positions[][quantity]	[Обязательный] Количество
positions[][locId]	[Обязательный] Идентификатор МХ, где лежит товар для списания
positions[][itemId]	[Обязательный] Идентификатор партии товара
positions[][type]	[Обязательный] Тип списания. Возможные значения: брак - defect, порча - damage, кража - theft, недостача - shortage, истечение срока годности - expired, моральное устаревание - obsolescence, передача на безвозмездной основе - freeTransfer, форс-мажорные обстоятельства - forceMajeure, использование в собственной деятельности - internalUse
positions[][comment]	[Необязательный] Примечание для списания

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/createPositions

Параметры POST
userlogin=username&userpsw=md5pass&operation[creatorId]=123&operation[workerId]=456&position[0][quantity]=1&position[0][locId]=74&position[0][itemId]=147&position[0][type]=internalUse&position[1][quantity]=5&position[1][locId]=89&position[1][itemId]=12&position[1][type]=defect

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

Параметр	Описание
operation	Объект операции списания
positions	Массив объектов позиций списания

Операция получение позиций списания

Операция: /cp/ts/stockRemoval/getPositions

Метод: GET

Получение позиций операций списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
opIds	[Необязательный] Идентификаторы операций списания через запятую
locIds	[Необязательный] Идентификаторы мест хранения через запятую
itemIds	[Необязательный] Идентификаторы партий товара через запятую
types	[Необязательный] Типы списания
opStatuses	[Необязательный] Статусы операции списания через запятую. Возможные варианты: new - Новое, inProgress - В работе, completed - Завершено, canceled - Аннулировано
tagIds	[Необязательный] Идентификаторы тегов через запятую
limit	[Необязательный] Максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение - 1000. Если не указан, будет установлено максимально возможное значение
skip	[Необязательный] Количество операций в ответе, которое нужно пропустить

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/getPositions?userlogin=username&userpsw=md5pass&opIds=14,16&opStatuses=new,completed

Метод возвращает массив объектов позиций списания.

Операция изменения позиции списания

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

Метод: POST

Изменение позиции списания. Изменить возможно только позиции из операций в статусах “Новое” и “В работе”.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] ID позиции списания
quantity	[Необязательный] Количество
locId	[Необязательный] Идентификатор МХ, где лежит товар для списания
itemId	[Необязательный] Идентификатор партии товара
type	[Необязательный] Тип списания
comment	[Необязательный] Примечание для списания

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/updatePosition

Параметры POST
userlogin=username&userpsw=md5pass&id=144&quantity=3

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

Операция удаления позиции списания

Операция: /cp/ts/stockRemoval/deletePosition

Метод: POST

Удаление позиции списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] ID позиции списания

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/deletePosition

Параметры POST
userlogin=username&userpsw=md5pass&id=144

Метод в ответе ничего не возвращает.

Операция добавления файла к позиции списания

Операция: /cp/ts/stockRemoval/createPositionAttr

Метод: POST

Добавление файла к позиции списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] ID позиции списания
name	[Обязательный] Имя файла
file	[Обязательный] Файл в формате Base64

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/createPositionAttr

Параметры POST
userlogin=username&userpsw=md5pass&id=144&file=base64file&name=image.jpg

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

Параметр	Описание
name	Имя загруженного файла
contentType	Тип содержимого
fileAPIName	Имя файла
description	Описание файла
creatorId	ID создателя
uploadDate	Дата загрузки

Операция удаления файла у позиции списания

Операция: /cp/ts/stockRemoval/deletePositionAttr

Метод: POST

Удаление файла у позиции списания.

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] ID позиции списания
name	[Обязательный] Имя ранее загруженного файла

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/deletePositionAttr

Параметры POST
userlogin=username&userpsw=md5pass&id=144&name=fileName

Метод в ответе ничего не возвращает.

Операция обновления файла у позиции списания

Операция: /cp/ts/stockRemoval/updatePositionAttr

Метод: POST

Обновление файлов у позиции списания. Обновить возможно только имя файла и описание

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
id	[Обязательный] ID позиции списания
oldName	[Обязательный] Старое имя файла
newName	[Необязательный] Новое имя файла
description	[Необязательный] Новое описание файла

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

https://demo.public.api.abcp.ru/cp/ts/stockRemoval/updatePositionAttr

Параметры POST
userlogin=username&userpsw=md5pass&id=144&oldName=fileName.jpg&newName=newFileName.jpg

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

Параметр	Описание
name	Имя загруженного файла
contentType	Тип содержимого
fileAPIName	Имя файла
description	Описание файла
creatorId	ID создателя
uploadDate	Дата загрузки

Объект списания

Параметр	Тип	Описание
id	uint	Идентификатор операции списания
number	string	Номер операции списания
createDate	datetime	Дата и время создания списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339)
updateDate	datetime	Дата и время обновления списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339)
executionDate	datetime	Дата и время завершения списания в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС (rfc3339)
creatorId	uint	Идентификатор сотрудника-создателя
workerId	uint	Идентификатор сотрудника-исполнителя
legalPersonId	uint	ID юридического лица, для которого списываются товары
status	string	Статус операции списания. Возможные значения: new - Новое, inProgress - В работе, completed - Завершено, canceled - Аннулировано

Объект позиции списания

Параметр	Тип	Описание
id	uint	Идентификатор позиции списания
opId	uint	Идентификатор операции списания, к которой относится позиция
quantity	uint	Количество
locId	uint	Идентификатор МХ, где лежит товар для списания
itemId	uint	Идентификатор партии товара
type	string	Тип списания. Возможные значения: брак - defect, порча - damage, кража - theft, недостача - shortage, истечение срока годности - expired, моральное устаревание - obsolescence, передача на безвозмездной основе - freeTransfer, форс-мажорные обстоятельства - forceMajeure, использование в собственной деятельности - internalUse
attrs	json string	Приложенные к позиции файлы
comment	string	Примечание для списания

Поле	Описание
id	Идентификатор тега
name	Массив тегов
color	Цвет тега
fontColor	Цвет шрифта
goodsReceiptCount	Используется в приёмках
orderPickingCount	Используется в отгрузках
deliveryCount	Используется в доставках
deliveryPackageCount	Используется в упаковках
customerComplaintCount	Используется в возвратах
supplierReturnCount	Используется в возвратах поставщику
clientOrderCount	Используется в заказах
clientCount	Используется в клиентах
goodsReceiptPosCount	Используется в позициях приёмок
orderPickingPosCount	Используется в позициях отгрузок
customerComplaintPosCount	Используется в позициях возвратов
supplierReturnPosCount	Используется в позициях возвратов поставщику
clientOrderPosCount	Используется в позициях заказов
maxUsageCount	Максимум использований

Операция создания тега

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора

Параметры POST

Поле	Описание
name	Имя тега
color	Цвет тега

В ответе приходит массив с полями:

Поле	Описание
id	Идентификатор созданного тега

Операция удаления тега

Операция: /cp/ts/tags/delete

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора

Параметры POST

Поле	Описание
id	Идентификатор удаляемого тега

Ответ возвращает пустой массив

Связи тегов

Под "объектом" понимается тот объект, к которому осуществляется привязка тега.

Типы объектов перечислены в таблице.

Например, если objectId = 123, а objectType = 4, то объект - Клиент с id 123.

Операция получения списка связей тегов

Операция: /cp/ts/tagsRelationships/list

Метод: GET

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора
objectIds	Необязателен. Идентификаторы объектов через запятую
objectType	Необязателен. Тип объекта
groupByObjectId	Необязателен. Группировать теги по id объекта
withAllTags	Необязателен. оставит только объекты, на которых есть все теги из tagIds
tagIds	Необязателен. Идентификаторы тегов через запятую

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

https://demo.public.api.abcp.ru/cp/ts/tagsRelationships/list?userlogin=api@user.abcp.ru&userpsw=123&limit=20&objectIds=1,2,3&objectType=1&groupByObjectId=0&withAllTags=0&tagIds=24,25

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

Поле	Описание
total	Найдено записей
list	Массив связей тегов

Структура связей тегов:

Поле	Описание
tagId	Идентификатор тега
objectId	Идентификатор объекта
objectType	Тип объекта

Операция создания связи тега

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

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора

Параметры POST

Поле	Описание
tagId	Идентификатор тега
objectId	Идентификатор объекта
objectType	Тип объекта

В ответе приходит массив с полями:

Поле	Описание
tagId	Идентификатор тега
objectId	Идентификатор объекта
objectType	Тип объекта

Операция удаления тега

Операция: /cp/ts/tagsRelationships/delete

Метод: POST

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

Параметр	Описание
userlogin	Имя API-администратора
userpsw	md5-хэш пароля API-администратора

Параметры POST

Поле	Описание
tagId	Идентификатор тега
objectId	Идентификатор объекта
objectType	Тип объекта

Ответ возвращает пустой массив

Типы объектов тегов

код	объект
1	операция приемка
2	операция отгрузка
3	операция возврат от клиента
4	клиент
5	позиция приемки
6	позиция отгрузки
7	позиция возврата от клиента
8	операция возврата поставщику
9	позиция возврата поставщику
10	операция заказа клиента
11	позиция заказа клиента
12	операция доставки
13	место доставки

Платежи

Административные операции для работы с платежами.
* - обязательный параметр

Получение списка платежей

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
ids	uint[]	ID платежей через запятую
contractorId	uint	Идентификатор клиента
agreementId	uint	Идентификатор договора
amountStart	float	Минимальная сумма
amountEnd	float	Максимальная сумма
status[]	string[]	Список статусов
number	string	Номер платежа
requisiteId	uint	Идентификатор платежных реквизитов
skip	uint	Пропуск записей
limit	uint	Ограничение количества записей в выборке
paymentType	string	Типы оплаты платежа (строковые значения через запятую)
paymentMethodIds[]	uint[]	Список идентификаторов способов оплаты платежа
dateStart	string	Минимальная дата платежа в формате RFC3339
dateEnd	string	Максимальная дата платежа в формате RFC3339
updateDateStart	string	начальная дата диапазона поиска по времени обновления в формате rfc3339
updateDateEnd	string	конечная дата диапазона поиска по времени обновления в формате rfc3339
externalId	string	Параметр для связи с внешними сервисами
fields	string	Дополнительная информация (значения через запятую)

Параметр status

Значение	Описание
new	Новый
inProcess	В процессе
accepted	Подтвержден
rejected	Отклонен
canceled	Аннулирован

Параметр paymentType

Значение	Описание	Применение
customerPayment	Выручка от покупателя	Для поступлений (положительные суммы)
supplierReturn	Возврат средств от поставщика	Для поступлений (положительные суммы)
supplierPayment	Оплата поставщику	Для списаний (отрицательные суммы)
customerReturn	Возврат средств покупателю	Для списаний (отрицательные суммы)

Параметр paymentMethodIds
Для получения списка идентификаторов способов оплаты воспользуйтесь операцией получения списка способов оплаты.

Параметр fields
Во все методы для работы с платежами, которые возвращают модель операции, в запрос можно передать поле fields, которое подгрузит дополнительные данные. Поля перечислять через запятую.

Значение	Описание
agreement	Информация о соглашении
maxAvailableReturnPaymentSum	Максимально возможная сумма возврата
paymentMethod	Способ оплаты

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

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

Операция возвращает поля

Поле	Описание
list	Список объектов платежей.
totalCount	Общее кол-во платежей соответствующих фильтру

Создание платежа

Операция: POST /cp/ts/payments/create

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
paymentType^*	string	Тип платежа
paymentMethodId^*	uint	Идентификатор способа платежа
agreementId^*	uint	Идентификатор договора
authorId^*	uint	Идентификатор инициатора платежа (сотрудник)
amount^*	float	Сумма платежа (в валюте магазина)
date^*	string	Пользовательская дата платежа в формате rfc3339
status	string	Нужно передать - accepted, чтобы платеж был сразу завершен
paymentOrder	string	Номер платежного поручения
linkedPaymentId	uint	Номер связанного платежа на основе которого делается возврат. Обязательный параметр, если paymentType = supplierReturn
contractorId	uint	Идентификатор клиента
commission	float	Комиссия платежной системы (в валюте магазина)
comment	string	Комментарий заполняемый магазином, при создании платежа
fields	string	Дополнительная информация (значения через запятую)
externalId	string	Параметр для связи с внешними сервисами

Параметр paymentType
Описание параметра.

Параметр paymentMethodId
Для получения списка идентификаторов способов оплаты воспользуйтесь операцией получения списка способов оплаты.

Параметр fields
Описание параметра.

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

https://demo.public.api.abcp.ru/cp/ts/payments/create

Параметры POST

userlogin=username&userpsw=md5pass&paymentType=customerPayment&paymentMethodId=1&contractorId=1&agreementId=123&authorId=1&amount=123&date=2025-10-13T13:44:32Z

Метод возвращает объект платежа.

Обновление платежа

Операция: POST /cp/ts/payments/update

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
paymentId^*	float	Номер платежа
agreementId	uint	Идентификатор договора. Можно изменить, если платеж в статусе `new`
amount	float	Сумма платежа (в валюте магазина). Можно изменить, если платеж в статусе `new`
date	string	Пользовательская дата платежа в формате rfc3339. Нельзя изменить, если платеж в статусе `rejected` или `canceled`
status	string	Статус платежа. Доступные изменения из `new` в `inProcess` ,`accepted` и `canceled`, из `inProcess` в `accepted` и `canceled`, из `accepted` в `canceled`
paymentOrder	string	Номер платежного поручения. Нельзя изменить, если платеж в статусе `rejected` или `canceled`
commission	float	Комиссия платежной системы (в валюте магазина). Нельзя изменить, если платеж в статусе `rejected` или `canceled`
comment	string	Комментарий заполняемый магазином, при создании платежа. Нельзя изменить, если платеж в статусе `rejected` или `canceled`

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

https://demo.public.api.abcp.ru/cp/ts/payments/update

Параметры POST

userlogin=username&userpsw=md5pass&paymentId=100&amount=1000&status=accepted

Метод возвращает объект платежа.

Объект платежа

Параметр	Тип	Описание
id	uint	Идентификатор
number	string	Номер платежа сгенерированный по шаблону
date	string	Пользовательская дата платежа
amount	float	Сумма платежа (в валюте магазина)
paymentMethodId	uint	Идентификатор способа оплаты
status	string	Статус платежа
type	string	Тип платежа
paymentOrder	string	Номер платежного поручения
commission	float	Комиссия платежной системы (в валюте магазина)
contractorId	uint	Идентификатор контрагента
agreementId	uint	Идентификатор договора
shopRequisiteId	uint	Идентификатор платежных реквизитов магазина
contractorRequisiteId	uint	Идентификатор платежных реквизитов получателя
createdTime	datetime	Дата создания платежа
updateTime	datetime	Дата обновления платежа
authorId	uint	Идентификатор инициатора платежа (сотрудник)
linkedPaymentId	uint	Идентификатор связанного платежа
data	json	Дополнительная информация
comment	string	Комментарий к платежу
externalId	string	Параметр для связи с внешними сервисами

Способы оплаты

Административные операции для работы со способами оплаты.
* - обязательный параметр

Получение списка способов оплаты

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
paymentType	string	Тип оплаты
allowChangePayment	string	Вариант доступности изменения платежа
states	string	Состояние

Параметр paymentType

Значение	Описание
cash	Наличный расчет
terminal	Оплата через терминал
cashless	Безналичный расчет
sber	Сбербанк Онлайн
tinkoff	Тинькофф
yooKassa	YooKassa

Параметр allowChangePayment

Значение	Описание
yes	Можно изменять платежи в ПУ (используется по умолчанию)
paymentInterfaceOnly	Только в интерфейсе платежа
editOnly	Только редактирование
no	Нельзя изменять платежи в ПУ

Параметр states

Значение	Описание
available	Доступен (используется по умолчанию)
notForClient	Не для клиентов
notForManager	Не для менеджера
unableToFinish	Невозможно завершить

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

Объект способа оплаты

Параметр	Тип	Описание
id	uint	Идентификатор
name	string	Название
paymentType	string	Тип оплаты
requisiteID	uint	Идентификатор реквизитов в Contractor Legal API
state	string	Состояние
numberTemplate	string	Шаблон с плейсхолдером {id}
allowChangePayment	string	Доступно ли изменение платежей в ПУ
profilesData	uint[]	Список профилей для которых доступно в json

Доставки

Административные операции для работы с доставками.
* - обязательный параметр

Получение списка доставок

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
ids	string	список ID (набор значений через запятую)
clientIds	string	Список ID клиентов (набор значений через запятую)
agreementIds	string	Список ID договоров (набор значений через запятую)
methodIds	string	Список ID способов доставки (набор значений через запятую)
creatorId	int	Идентификатор сотрудника-создателя
workerId	int	Идентификатор сотрудника-исполнителя
statuses	string	Список статусов: needPrepaid, new, inProgress, ready, completed, canceled (набор значений через запятую)
paymentForm	string	Предоплата или постоплата. Принимает значения payment или prepayment
numbers	string	Номера операций, несколько значения указываются через запятую
createDateStart	datetime	Начальная дата диапазона поиска по времени создания в формате rfc3339
createDateEnd	datetime	Конечная дата диапазона поиска по времени создания в формате rfc3339
updateDateStart	datetime	Начальная дата диапазона поиска по времени обновления в формате rfc3339
updateDateEnd	datetime	Конечная дата диапазона поиска по времени обновления в формате rfc3339
executionDateStart	datetime	Начальная дата диапазона поиска завершения доставки в формате rfc3339
executionDateEnd	datetime	Конечная дата диапазона поиска завершения доставки в формате rfc3339
coOrderIds	string	Список ID заказов клиентов (набор значений через запятую)
managerAttentions	string	Список свойств "Требуется внимания менеджера" (набор значений через запятую)
notUseInFinanceModule	bool	Участвует в финмодуле или нет. Если true, то отбираются доставки, которые не участвуют в финмодуле
skip	int	Количество операций в ответе, которое нужно пропустить
limit	int	Ограничение по кол-ву доставок в выдаче
fields	string	Расширенный формат вывода. Набор из следующих строк через запятую: agreement - договор, по которому выполнена отгрузка tags - теги posInfo - информация о позициях method - информация о способе доставки orderPickings - информация о связанной операции отгрузки

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

https://demo.public.api.abcp.ru/cp/ts/delivery/list?userlogin=username&userpsw=md5pass&clientIds=555&limit=30&statuses=inProgress,completed

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

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

Обновление доставки

Операция: POST /cp/ts/delivery/update

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

Параметр	Тип	Описание
userlogin^*	string	имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id	uint	идентификатор операции
number	string	номер операции
creatorId	uint	ID сотрудника-создателя операции
workerId	uint	ID сотрудника-исполнителя
trackNumber	string	номер для отслеживания
createDate	string	дата создания
startTime	uint	начало интервала доставки
endTime	uint	конец интервала доставки
price	float	цена в валюте магазина
clToResRate	float	курс между валютой магазина и валютой договора
clPrice	float	цена в валюте договора с клиентом
notUseInFinanceModule	bool	признак "Не проводить в финмодуле"
managerAttention	string	признак "Требуется внимание менеджера", возможные значения: none, notice, problem
isWeightRequired	bool	признак обязательности веса
priceNotConfirmed	bool	признак "Стоимость уточняется"
data	object	дополнительные сведения
data[contractorInfo]	object	информация об адресате
data[contractorInfo][address]	string	полный адрес
data[contractorInfo][comment]	string	дополнительная информация
data[contractorInfo][contact]	string	телефон для связи
data[contractorInfo][person]	string	контактное лицо
data[contractorInfo][employeePerson]	string	имя сотрудника
data[contractorInfo][employeeContact]	string	телефон сотрудника
data[contractorInfo][resellerComment]	string	комментарий о месте доставки от магазина
data[contractorInfo][officeId]	uint	офис самовывоза

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

https://demo.public.api.abcp.ru/cp/ts/delivery/update

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&number=123&trackNumber=111222

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

Изменение статуса доставки

Операция: POST /cp/ts/delivery/changeStatus

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

Параметр	Тип	Описание
userlogin^*	string	имя API-администратора
userpsw^*	string	md5-хэш пароля API-администратора
id^*	uint	идентификатор операции
status^*	string	Статус операции. Возможные значения "needPrepaid" - Требуется предоплат, "new" - Новая, "inProgress" - В работе, "ready" - Готово к выдаче , "completed" - Завершена, "canceled" - Аннулирована

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

https://demo.public.api.abcp.ru/cp/ts/delivery/changeStatus

Параметры POST

userlogin=username&userpsw=md5pass&id=1234&changeStatus=inProgress

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

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

Поле	Описание
id	идентификатор операции
number	номер операции
createDate	дата создания
contractorId	ID клиента
creatorId	ID сотрудника-создателя операции
workerId	ID сотрудника-исполнителя
agreementId	ID договора
methodId	ID способа доставки
status	статус операции
trackNumber	номер для отсеживания
startTime	начало интервала доставки
endTime	конец интервала доставки
price	цена в валюте магазина
clToResRate	курс между валютой магазина и валютой договора
clPrice	цена в валюте договора с клиентом
clPriceWOFinModule	цена (не участвует в финмодуле)
paymentForm	форма оплаты предоплата/постоплата
isWeightRequired	признак обязательности веса у всех позиций
executionDate	дата завершения
managerAttention	признак "Требуется внимание менеджера", возможные значения: none, notice, problem
tags	теги
data[contractorInfo][address]	полный адрес
data[contractorInfo][comment]	дополнительная информация
data[contractorInfo][contact]	телефон для связи
data[contractorInfo][person]	контактное лицо
data[contractorInfo][employeePerson]	имя сотрудника
data[contractorInfo][employeeContact]	телефон сотрудника
data[contractorInfo][resellerComment]	комментарий о месте доставки от магазина
data[contractorInfo][officeId]	офис самовывоза
data[amount]	суммарная стоимость позиций
data[quantity]	суммарное количество товара
data[volume]	суммарный объем
data[weight]	суммарная масса
data[maxSize]	наибольший размер товара в доставке
data[maxSizesSum]	наибольшая сумма измерений товара в доставки
data[versta24]	информация по доставке через versta24
data[priceNotConfirmed]	признак "Стоимость уточняется"

Способы доставки

Административные операции для работы со способами оплаты.
* - обязательный параметр

Получение списка способов доставки

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя api-администратора
userpsw^*	string	md5-хэш пароля api-администратора
ids	string	Список идентификаторов способов доставки через запятую
type	string	Список типов способов доставки через запятую. (Возможные значения: "pickup" - самовывоз, "courier" - курьер, "versta24" - верста24, "custom" - прочие без интеграции)
state	string	Список состояний способов доставки через запятую (Возможные значения: "client" - доступен, "manager" - недоступно для клиента, "admin" - недоступно для менеджера, "cannotComplete" - нельзя создать, "hidden" - нельзя создать, скрыть)
limit	uint	Максимальное количество объектов в выдаче
skip	uint	Пропуск объектов в выдаче

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

Поле	Описание
total	число найденных способов доставки
list	список найденных объектов способов доставки

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

Параметр	Тип	Описание
id	uint	Идентификатор
name	string	Название способа доставка
type	string	Тип способа доставки (Возможные значения: "pickup" - самовывоз, "courier" - курьер, "versta24" - верста24, "custom" - прочие без интеграции)
state	uint	Состояние способа доставки (Возможные значения: "client" - доступен, "manager" - недоступно для клиента, "admin" - недоступно для менеджера, "cannotComplete" - нельзя создать, "hidden" - нельзя создать, скрыть)
isNeedPacking	uint\|null	Признак необходимости упаковки
bounds	object	Ограничения способа доставки
data	object	Дополнительная информация

Объект ограничений способа доставки

Параметр	Тип	Описание
minWeight	float	Минимальный вес
maxWeight	float	Максимальный вес
minAmount	float	Минимальная стоимость
maxAmount	float	Максимальная стоимость
maxSize	float	Максимальный размер в мм
maxSizesSum	float	Максимальная сумма измерений товара в мм
profileIds	[]uint	Профили, которым доступен способ
officeIds	[]uint	Клиентам каких офисов доступен способ
restrictedOfficeIds	[]uint	Клиентам каких офисов недоступен способ

Объект дополнительной информации способа доставки

Параметр	Тип	Описание
description	string	Описание способа доставки
nameForPF	string	Наименование услуги доставки в ПФ
addresses	[]object	Объект с адресами самовывоза (если не используются офисы самовывоза)
timeIntervals	[]object	Объект интервалов доставки
priceData	[]object	Объект с данными для расчёта стоимости
trackingLinkTemplate	string	Шаблон ссылки для отслеживания
useOffices	bool	Признак использования офисов для самовывоза
officeIds	[]uint	Список офисов, доступных для самовывоза
isWeightRequired	bool	Признак обязательности веса
notUseInFinanceModule	bool	Признак "Не проводить в финмодуле"
priceNotConfirmed	bool	Признак "Стоимость уточняется"

Объект с адресами самовывоза способа доставки

Параметр	Тип	Описание
address	string	Полный адрес
comment	string	Дополнительная информация
contact	string	Телефон для связи
person	string	Контактное лицо

Объект с интервалами доставки

Параметр	Тип	Описание
day	uint	День недели
startTime	string	Начало интервала
endTime	string	Конец интервала

Объект с данными для расчета стоимости доставки

Параметр	Тип	Описание
basePrice	float	Базовая цена
minPrice	float	Минимальная стоимость
priceUpByQuantity	float	Наценка за количество
priceUpByWeight	float	Наценка за массу
priceUpByVolume	float	Наценка за объём
priceUpByAmount	float	Наценка от стоимости

Получение доступных способов доставки по позициям корзины

Операция: /cp/ts/deliveryMethod/forCo

Метод: GET

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

Параметр	Описание
userlogin^*	Имя контрагента
userpsw^*	md5-хэш пароля контрагента
cartPositionIds^*	id позиций корзины через запятую
clientid*	id клиента
type	Тип способа доставки. pickup - Самовывоз, courier - собственный курьер, custom - другое, integration - ТК.

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

https://demo.public.api.abcp.ru/cp/ts/deliveryMethod/forCo?userlogin=username&userpsw=md5pass&cartPositionIds=111,222&clientid=1234567

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

Поле	Описание
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]	Контактное лицо адреса самовывоза

Договоры

Административные операции для работы с договорами.
* - обязательный параметр

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

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя api-администратора
userpsw^*	string	md5-хэш пароля api-администратора
ids	[]uint	Список идентификаторов договоров
contractorIds	[]uint	Список идентификаторов контрагента
contractorRequisiteIds	[]uint	Список идентификаторов платёжных реквизитов контрагента
shopRequisiteIds	[]uint	Список идентификаторов платёжных реквизитов магазина
isActive	bool	Признак активности
isDefault	bool	Признак договора по умолчанию
agreementType	uint8	Тип договора
relationType	uint8	Тип отношений
number	string	Частичный номер
taxNumber	string	Идентификационный номер налогоплательщика (ИНН для РФ)
currency	string	Валюта
dateStart	datetime	Минимальная дата создания в формате RFC3339
dateEnd	datetime	Максимальная дата создания в формате RFC3339
updateDateStart	datetime	Минимальная дата обновления в формате RFC3399
updateDateEnd	datetime	Максимальная дата обновления в формате RFC3399
creditLimit	float64	Лимит кредита
limit	uint	Максимальное количество объектов в выдаче
offset	uint	Пропуск объектов в выдаче

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

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

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

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

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

Параметр	Тип	Описание
id	uint	Идентификатор
createDate	datetime	Дата создания
updateDate	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	Дата и время начала отсрочки платежей

Юридические лица

Административные операции для работы с юридическими лицами.
* - обязательный параметр

Получение списка юридических лиц

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

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

Параметр	Тип	Описание
userlogin^*	string	Имя api-администратора
userpsw^*	string	md5-хэш пароля api-администратора
ids	string	Идентификаторы ЮЛ через запятую и без пробелов
contractorId	uint	Идентификатор контрагента
contractorIds	string	Идентификаторы контрагента через запятую
form	uint	Организационно-правовая форма
type	uint	Тип организационно-правовой формы
agreementWithIndividualsRequired	uint8	Признак обязательности договора м/у ЮЛ и физ. лицами
withTaxSystems	uint8	Добавить в ответ СНО
limit	uint	Максимальное количество объектов в выдаче, но не более 50-ти
skip	uint	Пропуск объектов в выдаче

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

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

Метод возвращает набор объектов юридических лиц.

Внимание!
Если в запросе не передан contractorId в ответе будут список всех юридических лиц магазина

Объект юридического лица

Параметр	Тип	Описание
id	uint	Идентификатор ЮЛ
contractorId	uint	Идентификатор контрагента
vatPercent	float64	НДС в процентах
form	uint	Организационно-правовая форма
type	string	Тип организационно-правовой формы
name	string	Полное наименование
shortName	string	Краткое наименование
legalAddress	string	Юридический адрес
factAddress	string	Фактический адрес
amenableName	string	ФИО ответственного
amenablePosition	string	Должность ответственного
accountantName	string	Бухгалтер
agreementWithIndividualsRequired	bool	Признак обязательности договора м/у этим ЮЛ и физ.лицами
taxSystems	null	СНО юридического лица
properties	map[string]Property	Свойства юридического лица. Проиндексированы по кодам свойств

Объект свойств юридического лица

Параметр	Тип	Описание
name	string	Идентификаторы описания основного реквизита
type	string	Тип юридического лица
searchType	uint	Поисковой тип
validation	string	Регулярное выражение для валидации
placeholder	string	Пример заполненного поля
nameHV	string	Локализованное название свойства
value	string	Заполненное значение

Внимание!
Поле value может отсутствовать в объекте ответа по причине его незаполненности.

Коды свойств юридических лиц по странам

Российская Федерация

Параметр	Описание
300	Основной государственный регистрационный номер ИП
301	Индивидуальный налоговый номер ИП
302	Код причины постановки на учёт
303	Основной государственный регистрационный номер юр.лица
304	Индивидуальный налоговый номер юр.лица
305	Сертификат индивидуального предпринимателя
306	Общероссийский Классификатор Предприятий и Организаций (ЮЛ)
307	Общероссийский Классификатор Предприятий и Организаций (ИП)

Беларусь

Параметр	Описание
300	Основной государственный регистрационный номер ИП
301	Учётный номер плательщика (юр.лицо)

Украина

Параметр	Описание
300	Регистрационный номер в едином государственном реестре предприятий и организаций Украины
301	Индивидуальный налоговый номер

Казахстан

Параметр	Описание
300	Бизнес-идентификационный номер BG
301	Индивидуальный налоговый номер
302	Бизнес-идентификационный номер юр.лица

Латвия

Параметр	Описание
300	Реестровый номер предприятия (ИП)
301	Номер плательщика НДС (ИП)
302	Реестровый номер предприятия (компания)
303	Номер плательщика НДС (компания)

Литва

Параметр	Описание
300	Реестровый номер предприятия (ИП)
301	Номер плательщика НДС (ИП)
302	Реестровый номер предприятия (ИП)
303	Номер плательщика НДС (ИП)

Армения

Параметр	Описание
300	Учетный номер налогоплательщика, ИП
301	Учетный номер налогоплательщика, организация

Турция

Параметр	Описание
300	Налоговый номер (ИП)
301	Номер в центральной регистрационной системе (ИП)
302	Номер лицензии (юр.лицо)
303	Орган и дата выдачи лицензии (юр.лицо)
304	Налоговый номер (юрлицо)

Объединенные Арабские Эмираты (ОАЭ)

Параметр	Описание
300	Номер лицензии (ИП)
301	Орган и дата выдачи лицензии (ИП)
302	Номер лицензии (юр.лицо)
303	Орган и дата выдачи лицензии (юр.лицо)

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

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

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

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

Параметр	Тип	Описание
orderIds	[]uint	Список идентификаторов заказов
distributorIds	[]uint	Список идентификаторов прайс-листов
supplierIds	[]uint	Список идентификаторов контрагентов-поставщиков
sendStatuses	[]uint	Список статусов отправки заказа. Варианты: 1 - отправляется, 2 - отправлен, 3 - ошибка, 4 - отправка не требуется
createDateStart	string	Начальная дата в диапазоне поиска по дате создания заказа. Формат rfc3339.
createDateEnd	[]uint	Конечная дата в диапазоне поиска по дате создания заказа. Формат rfc3339.
sendDateStart	string	Начальная дата в диапазоне поиска по дате отправки заказа. Формат rfc3339.
sendDateEnd	[]uint	Конечная дата в диапазоне поиска по дате отправки заказа. Формат rfc3339.
clientOrderId	uint	Идентификатор заказа клиента
clientOrderNumber	string	Номер заказа клиента
limit	uint	Максимально количество объектов в выдаче
skip	uint	Пропуск объектов в выдаче

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

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

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

Параметр	Тип	Описание
statuses	[]uint	Список статусов
orderId	uint	идентификатор заказа
distributorIds	[]uint	Список идентификаторов прайс-листов
supplierIds	[]uint	Список идентификаторов контрагентов-поставщиков
positionIds	[]uint	Список идентификаторов позиций
grPositionIds	[]uint	Список идентификаторов операций приемки
clientOrderId	uint	Идентификатор заказа клиента
clientOrderNumber	string	Номер заказа клиента
withoutOrder	bool	Только позиции без созданного заказа
withOrder	bool	Только позиции с созданным заказов
additionalInfo	string	Дополнительная информация: products - добавить информацию о товарах, coIds - добавить ссылки на связанные позиции заказов клиентов, order - добавить информацию о заказе поставщику
limit	uint	Максимально количество объектов в выдаче
skip	uint	Пропуск объектов в выдаче

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

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

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

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

4 - В пути

5 - Прибыл

6 - Выполнен

7 - Отказ

Склад

Получение информации о ячейках склада

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

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

Параметр	Тип	Описание
userlogin	string	Имя api-администратора
userpsw	string	md5-хэш пароля api-администратора

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

Поле	Описание
total	число найденных ячеек
list	список найденных ячеек