Структура заказа (order data object)
Описание
Объект order
используется в API запросах, связанных с импортом заказов в маркет.
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
external_id | string | "123456" | Да | Идентификатор заказа |
matching | string | "email" | Нет | Режим поиска подписчика. По умолчанию – email. Для каждого типа матчинга в теле запроса необходимо передавать определенные поля. Подробнее об этих полях можно узнать здесь. |
endpoint | string | "website" | Да | Дополнительный идентификатор точки продажи |
tags | array | ["one","two"] | Нет | Список тегов |
status | string | "new" "delivered" "paid" "canceled" "part_refunded" | Да | Идентификатор статуса заказа |
delivery_cost | string | "200" | Нет | Стоимость доставки |
total_price | string | "3000" | Да | Общая стоимость заказа. Складывается из суммы каждой позиции в заказе и стоимости доставки. |
currency | string | "USD" | Да | Валюта, в которой указана стоимость заказа. Валюты настраиваются в интерфейсе платформы: Маркет → Настройки → Другое. Если в запросе передать валюту, которая не задана в платформе, произойдет ошибка. |
create_time | string | "2006-01-23T15:04:05.141Z" | Нет | Дата создания заказа (формат RFC3339) |
update_time | string | "2006-01-23T15:04:05.141Z" | Нет | Дата обновления заказа (формат RFC3339) |
custom_fields | object | { | Нет | Значение дополнительных полей заказа."[id_доп_поля]": "[значение_доп_поля]" |
region | string | "region_external_id" | Нет | Дополнительный идентификатор региона. Создать регион и получить его идентификатор можно в интерфейсе платформы: Маркет → Настройки. |
lines | array | [ | Да | Данные о позициях заказа. Минимум одна позиция. См. ниже. |
JSON
- JSON
- XML
[
{
"external_id": "123456",
"matching": "email",
"email": "johndoe@example.com",
"endpoint": "endpoint_external_id",
"tags": [
"one",
"two"
],
"status": "new",
"delivery_cost": "100",
"total_price": "1000",
"currency": "USD",
"custom_fields": {
"order_field_id_1": "data",
"order_field_id_2": 123
},
"region": "region_external_id",
"lines": [
{
"external_id": "1234000",
"status": "new",
"sku": "sku_external_id",
"base_price_per_item": "900",
"min_price_per_item": "900",
"final_price_per_item": "900",
"count": 5,
"custom_fields": {
"line_field_id_2": "data",
"line_field_id_1": 123
}
}
]
}
]
<xml>
<row>
<external_id>123456</external_id>
<matching>email</matching>
<email>johndoe@example.com</email>
<endpoint>endpoint_external_id</endpoint>
<tags>one</tags>
<tags>two</tags>
<status>new</status>
<delivery_cost>100</delivery_cost>
<total_price>1000</total_price>
<currency>USD</currency>
<custom_fields>
<order_field_id_1>data</order_field_id_1>
<order_field_id_2>123</order_field_id_2>
</custom_fields>
<region>region_external_id</region>
<lines>
<external_id>1234000</external_id>
<status>0001</status>
<sku>sku_external_id</sku>
<base_price_per_item>900</base_price_per_item>
<min_price_per_item>900</min_price_per_item>
<final_price_per_item>900</final_price_per_item>
<count>5</count>
<custom_fields>
<line_field_id_2>data</line_field_id_2>
<line_field_id_1>123</line_field_id_1>
</custom_fields>
</lines>
</row>
</xml>