Описание метода в api версии 1

Назначение

Используется для принятия заказа клиента в работу. Выполняется запуск процесса сборки товаров по заказу.

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

Пример демонстрирует вызов метода /order/list.

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

POST /ExternalExchange/v1/order/startOrderProcess HTTP/1.1 
Content-Type: application/json; 

{
	"merchantId": "000000006",
	"orderNumberInPersonalCabinet": "021020442",
	"orderId": "",
	"externalSystemId": "000000002"
}
JS

Пример успешного ответа

{
	"message": "Order 021020442 was started to process successfully.",
	"success": true,
	"successInAllSubrequests": true
}
JS

Пример ответа c ошибками
JS

Описание параметров запроса


ПараметрТипОбязателенОписание
1merchantIdstringДа

Внутренний идентификатор личного кабинета торговой площадки

2orderNumberInPersonalCabinetstringНет

Номер заказ клиента в личном кабинете торговой площадки

3orderIdstringНетИдентификатор заказа
4externalSystemIdstringДаКод внешней системы откуда идет запрос к сервису

Описание параметров ответа


ПараметрТипОбязателенОписание
1messagestringДа

Описание результата запроса:

  • "Personal cabinet was not found by merchantId" - Не удалось найти подключение к личному кабинету по переданному коду мерчанта
  • "Fields orderId and orderNumberInPersonalCabinet are both empty. At least one of these fields must be filled." - Номер заказа и идентификатор заказа не могут быть пусты одновременно. Должен быть заполнен хотя бы один из параметров.
  • "Document 'Client order' was not created for order" - Не создан документ 1С "Заказ клиента" на основании заказа торговой площадки
  • "Document 'Client order' %1 was not correctly processed for order %2 (client order is not posted)" - Документ 1С "Заказ клиента" не проведен
  • "Document 'Rashodniy Order' was not found for order %1" - Не создан документ 1С "Расходный ордер на товары" на основании заказа торговой площадки
  • "Document 'Rashodniy Order' %1 was not correctly processed for order %2 (client order is not posted)" - Документ 1С "Расходный ордер на товары" не проведен или возникли ошибки при проверки условий возможности подтверждения заказа
  • "Order %1 was started to process successfully." - успешно
2successInAllSubrequestsbooleanДа

Статус выполнения подзапросов метода

  • true - все подзапросы метода выполнены успешно
  • false - подзапрос выполнен с ошибкой. Описание ошибки см. в параметре message
3successbooleanДа

Общий статус запроса

  • true - запрос успешный
  • false - выполнен с ошибкой