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

Назначение

Возвращает полную информацию по конкретному заказу клиента.

Пример запроса JSON (v2)

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

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

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

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

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

{
	"merchantId": "000000001",
	"orderId": "021020442",	
	"orderNumberInPersonalCabinet": "021020442", 
	"shipmentDate": "2021-02-11T13:23:39Z",
	"orderCreatedAs1CDocument": true,
	"status": "AWAITING_PACKAGING",
	"creationDate": "2021-02-11T13:24:00Z",
	"originalShipmentNumber": "",
	"updateDate": "2021-02-11T13:24:00Z",
	"message": "Request was valid.",
	"successInAllSubrequests": true,
	"success": true,
	"items": [
		{
			"itemId": "1",	
 			"externalSystemProductId": "00-07011121", 
			"marketplaceProductId": "", 		
			"name": "Самый лучший товар",
			"status": "AWAITING_PACKAGING",
			"quantity": "1",
			"price": 1000,			
			"finalPrice": 1000,
			"isSet": true,
			"setOfGoods": [
				{
					"externalSystemProductId": "bd3b70b0-7d02-11ec-cf9f-ac1f6b7c4cde",
					"marketplaceProductId": "",
					"name": "Первая половинка товара",
					"quantity": 10,
					"costShare": 0
				},
				{
					"externalSystemProductId": "bd3b70b0-7d02-11ec-cf9f-ac1f6b7c4cdf",
					"marketplaceProductId": "",
					"name": "Вторая половинка товара",
					"quantity": 10,
					"costShare": 0
				}
			]
		}
	]
}
JS

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

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


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

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

2orderIdstringНет

Идентификатор заказа

3orderNumberInPersonalCabinetstringНетНомер заказ клиента в личном кабинете торговой площадки
4externalSystemIdstringНетКод внешней системы откуда идет подключение к базе маркета

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


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

Параметры
1orderIdstringДаИдентификатор заказа
2orderNumberInPersonalCabinetstringДаНомер заказ клиента в личном кабинете торговой площадки
3shipmentDatestringДа

Предполагаемая дата отгрузки. Дата в формате ISO.

4orderCreatedAs1CDocumentbooleanНет

Признак наличия проведенного документа 1С "Заказ клиента" в базе маркета. 

  • true - заказ клиента проведен
  • false - заказ клиента не проведен или не существует
5statusstringНет

Текстовый идентификатор статуса заказа клиента. 

Возможные значения:

  • "AWAITING_APPROVE" - Подтверждение
  • "AWAITING_PACKAGING" - Комплектация
  • "PACKED" - Скомплектован
  • "SHIPPED" - Отгружен
  • "DELIVERED" - Доставлен
  • "CANCELLED" - Отменен
  • "SOLD" - Отражена реализация
  • "UNDEFINED" - не определен
6creationDatestringНетДата создания заказа площадки в базе маркета. Дата в формате ISO.
7originalShipmentNumberstringДаИсходный номер отправления в личном кабинете торговой площадки
8updateDatestringНетДата последнего обновления заказа площадки в базе маркета. Дата в формате ISO.
9messagestringДа

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

  • "Request was valid" - Успешный запрос
  • "merchantId is not specified in request" - Не заполнен идентификатор мерчанта (код подключения к личному кабинету)
  • "Fields orderId and orderNumberInPersonalCabinet are both empty. At least one of these fields must be filled. - Номер заказа и идентификатор заказа не могут быть пусты одновременно. Должен быть заполнен хотя бы один из параметров.
  • "Personal cabinet was not found by merchantId = " - Не удалось найти подключение кличному кабинету по переданному коду мерчанта
  • "Order was not found by orderId and/or orderNumberInPersonalCabinet" - Не удалось найти заказ по идентификатору и/или номеру заказа в личном кабинете
  • "Request was valid but order items was not found for" - В базе 1С отсутствуют данные о позициях заказа
10successInAllSubrequestsbooleanДа

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

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

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

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

itemsМассивНет

Массив товаров заказа клиента с описанием. Может быть пустым при ошибке.

12itemIdstringДаИдентификатор позиции заказа (строка в заказе)
13externalSystemProductIdstringДаИдентификатор товара в системе клиента (внешней системе). Например, код справочника "Номенклатура" в системе клиента 1С.
14marketplaceProductIdstringДаИдентификатор товара на торговой площадке
15namestringДаНаименование товара
16statusstringДа

Текстовый идентификатор статуса позиции заказа клиента. 

Возможные значения:

  • "AWAITING_APPROVE" - Подтверждение
  • "AWAITING_PACKAGING" - Комплектация
  • "PACKED" - Скомплектован
  • "SHIPPED" - Отгружен
  • "DELIVERED" - Доставлен
  • "CANCELLED" - Отменен
  • "SOLD" - Отражена реализация
  • "UNDEFINED" - не определен
17quantityintegerДаКоличество товара
18pricefloatДаЦена товара
19finalPricefloatДаИтоговая стоимость товара (цена со скидкой).
20isSetbooleanДа

Признак, указывающий на наличие составляющих товара:

  • false - обычный товар;
  • true - товар состоит из комплектующих, которые в конечном заказе могут заменить собой сам комплект.

setOfGoodsМассивНетМассив комплектующих товара, если таковые имеются.
21externalSystemProductIdstringДаИдентификатор комплектующего товара в системе клиента (внешней системе).
22marketplaceProductIdstringДаИдентификатор комплектующего на торговой площадке (всегда пустой).
23namestringДаНаименование комплектующего.
24quantityintegerДаОбщее количество комплектующего в составе товара-комплекта.
25costShareintegerДаДоля стоимости комплектующего в составе комплекта. Если доля определяется количеством, для всех комплектующих устанавливается значение 0.

Мэппинг действий от статусов

Статус заказа клиентаСтатус позиций в заказеДополнительные условияДействие в учетной системе
WAITING_DATA_FROM_MARKETPLACEОжидание подтверждения
Не производим
AWAITING_APPROVEОжидание подтверждения
Не производим
AWAITING_PACKAGINGПодтверждено
  • Создаем заказ
  • Создаем резервирование товаров
  • Устанавливаем номер заказа маркетплейса в поле комментарий

AWAITING_PACKAGINGОтменено
  • Создаем заказ только на подтвержденные позиции
  • Создаем резервирование товаров
  • Устанавливаем номер заказа маркетплейса в поле комментарий
PACKEDПодтверждено
Не производим
SHIPPEDПодтверждено
Не производим
DELIVEREDПодтверждено
Не производим
CANCELLED ОтмененоПосле статуса AWAITING_PACKAGING
  • Снимаем резервирование товара
  • устанавливаем статус заказа CANCELLED (Отменен)
CANCELLED ОтмененоПосле статуса PACKED
  • Снимаем резервирование товара
  • устанавливаем статус заказа CANCELLED (Отменен)
CANCELLED ОтмененоПосле статуса SHIPPED
  • Создаем реализацию товаров и услуг
  • Устанавливаем номер заказа маркетплейса в поле комментарий
  • Устанавливаем в поле комментарий текст "К возврату"
  • Устанавливаем статус заказа CANCELLED
CANCELLEDОтмененоПосле статуса DELIVERED
  • Создаем реализацию товаров и услуг
  • Устанавливаем номер заказа маркетплейса в поле комментарий
  • Устанавливаем в поле комментарий текст "К возврату"
  • Устанавливаем статус заказа CANCELLED
CANCELLEDОтмененоПосле статуса SOLD
  • Устанавливаем в РТУ в поле комментарий текст "К возврату"
  • Устанавливаем статус заказа CANCELLED
SOLDПодтверждено
  • Создаем реализацию товаров и услуг

  • В поле комментарий устанавливаем номер заказа маркетплейса