Информация о заказе (v3/order/info)
Описание метода в api версии 3
Назначение
Возвращает полную информацию по конкретному заказу клиента.
Пример запроса JSON (v3)
Пример демонстрирует вызов метода /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",
"stockId": "f34a28a5-ea38-40f0-9612-1ef4915aceea",
"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
}
]
},
{
"itemId": "2",
"externalSystemProductId": "00-07011122",
"marketplaceProductId": "",
"name": "Самый лучший товар с марками",
"status": "AWAITING_PACKAGING",
"quantity": "2",
"price": 1000,
"finalPrice": 1000,
"isSet": false,
"cises": ["марка1", "марка2"]
}
]
}
JS
Пример ответа c ошибками
JS
Описание параметров запроса
| Параметр | Тип | Обязателен | Описание | |
|---|---|---|---|---|
| 1 | merchantId | string | Да | Внутренний идентификатор личного кабинета торговой площадки. |
| 2 | orderId | string | Нет | Идентификатор заказа |
| 3 | orderNumberInPersonalCabinet | string | Нет | Номер заказ клиента в личном кабинете торговой площадки |
| 4 | externalSystemId | string | Нет | Код внешней системы откуда идет подключение к базе маркета |
Описание параметров ответа
| Параметр | Тип | Обязателен | Описание | |
|---|---|---|---|---|
| Параметры | ||||
| 1 | orderId | string | Да | Идентификатор заказа |
| 2 | orderNumberInPersonalCabinet | string | Да | Номер заказ клиента в личном кабинете торговой площадки |
| 3 | stockId | string | Да, начиная с версии 11 апи маркета | Идентификатор склада |
| 4 | shipmentDate | string | Да | Предполагаемая дата отгрузки. Дата в формате ISO. |
| 5 | orderCreatedAs1CDocument | boolean | Нет | Признак наличия проведенного документа 1С "Заказ клиента" в базе маркета.
|
| 6 | status | string | Нет | Текстовый идентификатор статуса заказа клиента. Возможные значения:
|
| 7 | creationDate | string | Нет | Дата создания заказа площадки в базе маркета. Дата в формате ISO. |
| 8 | originalShipmentNumber | string | Да | Исходный номер отправления в личном кабинете торговой площадки |
| 9 | updateDate | string | Нет | Дата последнего обновления заказа площадки в базе маркета. Дата в формате ISO. |
| 10 | message | string | Да | Описание результата запроса.
|
| 11 | successInAllSubrequests | boolean | Да | Статус выполнения подзапросов метода
|
| 12 | success | boolean | Да | Общий статус запроса
|
| items | Массив | Нет | Массив товаров заказа клиента с описанием. Может быть пустым при ошибке. | |
| 13 | itemId | string | Да | Идентификатор позиции заказа (строка в заказе) |
| 14 | externalSystemProductId | string | Да | Идентификатор товара в системе клиента (внешней системе). Например, код справочника "Номенклатура" в системе клиента 1С. |
| 15 | marketplaceProductId | string | Да | Идентификатор товара на торговой площадке |
| 16 | name | string | Да | Наименование товара |
| 17 | status | string | Да | Текстовый идентификатор статуса позиции заказа клиента. Возможные значения:
|
| 18 | quantity | integer | Да | Количество товара |
| 19 | price | float | Да | Цена товара |
| 20 | finalPrice | float | Да | Итоговая стоимость товара (цена со скидкой). |
| 21 | isSet | boolean | Да | Признак, указывающий на наличие составляющих товара:
|
| 22 | cises | Массив | Нет | Строки с марками товара |
| setOfGoods | Массив | Нет | Массив комплектующих товара, если таковые имеются. | |
| 23 | externalSystemProductId | string | Да | Идентификатор комплектующего товара в системе клиента (внешней системе). |
| 24 | marketplaceProductId | string | Да | Идентификатор комплектующего на торговой площадке (всегда пустой). |
| 25 | name | string | Да | Наименование комплектующего. |
| 26 | quantity | integer | Да | Общее количество комплектующего в составе товара-комплекта. |
| 27 | costShare | integer | Да | Доля стоимости комплектующего в составе комплекта. Если доля определяется количеством, для всех комплектующих устанавливается значение 0. |
Мэппинг действий от статусов
| Статус заказа клиента | Статус позиций в заказе | Дополнительные условия | Действие в учетной системе |
|---|---|---|---|
| WAITING_DATA_FROM_MARKETPLACE | Ожидание подтверждения | Не производим | |
| AWAITING_APPROVE | Ожидание подтверждения | Не производим | |
| AWAITING_PACKAGING | Подтверждено |
| |
| AWAITING_PACKAGING | Отменено |
| |
| PACKED | Подтверждено | Не производим | |
| SHIPPED | Подтверждено | Не производим | |
| DELIVERED | Подтверждено | Не производим | |
| CANCELLED | Отменено | После статуса AWAITING_PACKAGING |
|
| CANCELLED | Отменено | После статуса PACKED |
|
| CANCELLED | Отменено | После статуса SHIPPED |
|
| CANCELLED | Отменено | После статуса DELIVERED |
|
| CANCELLED | Отменено | После статуса SOLD |
|
| SOLD | Подтверждено |
|