Возврат от покупателя
Преимущества
Получение списка операций возврата покупателя
Операция: ts/customerComplaints/get
Метод: GET
Для получения списка возвратов у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| auto | [необязательный] автоопределяемое поле (поиск по частичному номеру операции или идентификатору, если задано число) |
| creatorId | [необязательный] идентификатор сотрудника-создателя |
| expertId | [необязательный] идентификатор сотрудника-эксперта |
| orderPickingId | [необязательный] идентификатор отгрузки |
| positionStatuses | [необязательный] массив статусов позиций |
| tagIDs | [необязательный] массив идентификаторов тегов |
| positionAuto | [необязательный] автоопределяемый параметр для поиска по позициям операции |
| number | [необязательный] номер операции |
| dateStart | [необязательный] начальная дата диапазона поиска в формате rfc3339 |
| dateEnd | [необязательный] конечная дата диапазона поиска в формате rfc3339 |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| output | [необязательный] формат вывода, 'e' - загрузка дополнительной информации(операция отгрузки и договор), 's' - будет возвращена дополнительная информация о количестве позиций во всех возможных статусах. |
| fields | [необязательный] загрузка дополнительной информации. Строка со следующими параметрами через запятую: |
https://demo.public.api.abcp.ru/ts/customerComplaints/get?userlogin=username&userpsw=md5pass&limit=30&output=e&pickingId=33
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор операции возврата |
| number | Номер операции |
| createDate | Дата создания операции |
| creatorId | Идентификатор сотрудника-создателя |
| expertId | Идентификатор сотрудника-эксперта |
| clientId | Идентификатор клиента |
| agreementId | Идентификатор соглашения |
| agreement | Договор |
| orderPickingId | Идентификатор отгрузки, по который сделан возврат |
| orderPicking | Информация об операции отгрузки |
| positionCount | Количество позиций в операции |
| canceledPositionCount | Количество позиций в статусе "Аннулировано" |
Получение списка позиций возврата покупателя
Операция: ts/customerComplaints/getPositions
Метод: GET
Для получения списка позиций операции возврата у пользователя должно быть включено право доступа к API "Получение информации из TS"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| opId | [обязательный] идентификатор операции |
| orderPickingGoodId | [необязательный] идентификатор позиции отгрузки |
| orderPickingGoodIds | [необязательный] идентификаторы позиций расхода через запятую |
| pickingIds | [необязательный] идентификаторы операции расхода через запятую |
| oldCoPositionIds | [необязательный] идентификаторы позиции старого заказа через запятую |
| oldItemID | ☢ |
| itemId | [необязательный] идентификатор созданной партии |
| locId | [необязательный] идентификатор места хранения |
| status | [необязательный] статус позиции |
| dateStart | [необязательный] минимальная дата создания операции |
| dateEnd | [необязательный] максимальная дата создания операции |
| itemId | [необязательный] идентификатор партии |
| locId | [необязательный] идентификатор места хранения |
| status | статус позиции (1 - новый, 2 - в работе, 3 - отказ, 4 - подтверждён, 5 - выдано, 6 - аннулировано) |
| type | тип возврата (1 - возврат, 2 - отказ, 3 - брак.) |
| skip | [необязательный] количество операций в ответе, которое нужно пропустить |
| limit | [необязательный] максимальное количество операций, которое должно быть возвращено в ответе. Максимально возможное значение 1000. Если не указан будет установлено максимально возможное значение. |
| output | [необязательный] формат вывода, 'e' - загрузка дополнительной информации (справочные товары) |
| fields | [необязательный] Загрузка дополнительной информации. Строка со следующими параметрами через запятую: |
https://demo.public.api.abcp.ru/ts/customerComplaints/getPositions?userlogin=username&userpsw=md5pass&limit=30&output=e&opId=3&status=2&type=1
Метод возвращает массив объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции возраста |
| status | Статус |
| type | Тип возраста |
| orderPickingGoodId | Идентификатор позиции товара в операции отгрузки |
| oldItemId | Идентификатор отгруженной партии |
| itemId | Идентификатор партии, созданной данной позицией возврата |
| quantity | Количество |
| attrs | Объект, содержащий ссылки на загруженные документы и фотографии |
| product | Карточка товара |
| pickingDate | Дата и время выдачи товара клиенту |
| comment | Комментарий |
| orderPickingGood | Информация о позиции операции отгрузки |
| orderPicking | Информация об операции отгрузки |
| availableQuantity | Доступное для возврата количество |
Создание возврата покупателя
Операция: ts/customerComplaints/create
Метод: POST
Для создания операции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| orderPickingId | [обязательный] идентификатор отгрузки из которой возвращается товар |
| positions | [обязательный] список позиций |
| Поле | Описание |
|---|---|
| orderPickingPositionId | Идентификатор позиции отгрузки |
| quantity | Количество |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| comment | Комментарий |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/create
Параметры POST
userlogin=username&userpsw=md5pass&orderPickingId=100&positions[0][orderPickingPositionId]=1234&positions[0][quantity]=2&positions[0][type]=3&positions[0][comment]=comment%20for%20position0&positions[1][orderPickingPositionId]=1235&positions[1][quantity]=1&positions[1][type]=2&positions[0][comment]=comment%20for%20position1
Метод возвращает объект операции возврата:
| Поле | Описание |
|---|---|
| id | Идентификатор созданной операции |
| number | Номер операции |
| createDate | Дата создания |
| creatorId | Идентификатор пользователя, создавшего операцию |
| expertId | Идентификатор пользователя, назначенного в качестве эксперта |
| clientId | Идентификатор клиента |
| agreementId | Идентификатор договора с клиентом |
| orderPickingId | Идентификатор отгрузки |
| positionCount | Количество позиций в созданной операции |
| canceledPositionCount | Количество аннулированных позиций |
| positions | Список позиций |
Узел positions содержит набор объектов вида:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новый, 2-в работе, 3-отказ, 4-завершён, 5-выдано, 6-аннулировано, 7-заявка отклонена, 8-заявка подтверждена) |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по указанной отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| product | Карточка товара |
| orderPickingGood | Объект позиции отгрузки |
| orderPicking | Объект отгрузки |
| availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |
Изменение позиции возврата покупателя
Операция: ts/customerComplaints/updatePosition
Метод: POST
Возможно изменение только количества товара позиции. Изменение возможно только в статусе "новый".
Для изменения позиции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| id | [обязательный] идентификатор позиции возврата покупателя |
| quantity | [обязательный] количество |
Пример запроса
https://demo.public.api.abcp.ru/ts/customerComplaints/updatePosition
Параметры POST
userlogin=username&userpsw=md5pass&id=1234&quantity=2
Метод возвращает объект позиции возврата:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новый, 2-в работе, 3-отказ, 4-завершён, 5-выдано, 6-аннулировано, 7-заявка отклонена, 8-заявка подтверждена) |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по указанной отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| product | Карточка товара |
| orderPickingGood | Объект позиции отгрузки |
| orderPicking | Объект отгрузки |
| availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |
Отмена позиции возврата покупателя
Операция: ts/customerComplaints/cancelPosition
Метод: POST
Отмена позиции возможна только в статусе "новый". Отмена позиции происходит путём изменения статуса позиции в статус 6 - аннулировано.
Для отмены позиции возврата у пользователя должно быть включено право доступа к API "Создание возврата покупателя"
Параметры запроса
| Параметр | Описание |
|---|---|
| userlogin | Имя контрагента |
| userpsw | md5-хэш пароля контрагента |
| id | [обязательный] идентификатор позиции возврата покупателя |
https://demo.public.api.abcp.ru/ts/customerComplaints/cancelPosition
Параметры POST
userlogin=username&userpsw=md5pass&id=1234
Метод возвращает объект позиции возврата:
| Поле | Описание |
|---|---|
| id | Идентификатор позиции |
| opId | Идентификатор операции |
| status | Статус позиции (1-новый, 2-в работе, 3-отказ, 4-завершён, 5-выдано, 6-аннулировано, 7-заявка отклонена, 8-заявка подтверждена) |
| type | Тип возврата(1-возврат, 2-отказ, 3-брак) |
| orderPickingGoodId | Идентификатор позиции отгрузки |
| oldItemId | Идентификатор партии, отгруженной по отгрузке |
| itemId | Идентификатор партии, созданной операцией возврат(назначается при переводе позиции в статус "в работе" |
| locId | Идентификатор места хранения принятого товара |
| quantity | Количество |
| attrs | Список добавленных к позиции документов и изображений |
| pickingDate | Дата и время выдачи товара обратно клиенту |
| comment | Комментарий |
| product | Карточка товара |
| orderPickingGood | Объект позиции отгрузки |
| orderPicking | Объект отгрузки |
| availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |