Импорт заказа и статусов позиций
Описание
Импортирует в маркет заказ, метод оплат ы и статусы позиций.
URL-адрес
Метод: POST
https://example.com/api/v1.1/market/orders/import
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен Убедитесь, что для токена доступны роли, позволяющие работать с маркетом. |
custom_fields | array of objects | [ | Нет | Создание дополнительных полей для следующих сущностей:
|
custom_line_statuses | array of objects | [ | Нет | Кастомный статус позиции заказа. Необходимо передать идентификатор статуса ( external_id ), его название (name ) и тип (type ).Возможные значения поля type :
|
skip_triggers | bool | true | Нет | Пропустить запуск триггеров (по умолчанию – false) |
data | array of objects | [ | Да | Данные о заказе. Подробнее. |
Пример запроса JSON
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"custom_fields": [
{
"external_id": "order_field_id_123",
"name": "Дополнительное поле заказа",
"entity_type": "order",
"required": false,
"value_type": "unicode",
"default_value": "значение тестового поля"
},
{
"external_id": "line_field_id_123",
"name": "Дополнительное поле позиции заказа",
"entity_type": "line_order",
"required": false,
"value_type": "unicode",
"default_value": "значение тестового поля"
}
],
"custom_line_statuses": [
{
"external_id": "status_id_123",
"name": "Доставлен в пункт выдачи",
"type": "in_process"
}
],
"skip_triggers": true,
"data": [
{
"external_id": "1234000",
"matching": "email",
"email": "johndoe@example.com",
"endpoint": "website",
"tags": ["one", "two"],
"status": "delivered",
"delivery_cost": "100",
"total_price": "1000",
"currency": "USD",
"create_time": "2022-01-02T15:04:05.141Z",
"custom_fields": {
"order_field_id_123": "data"
},
"region": "region_YnCrJj8Y1",
"lines": [
{
"external_id": "line_01",
"status": "status_id_123",
"product": "iphone_test_1",
"base_price_per_item": "900",
"min_price_per_item": "900",
"final_price_per_item": "900",
"count": 1,
"custom_fields": {
"line_field_id_123": "data"
}
}
]
}
]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<custom_fields>
<external_id>order_field_id_123</external_id>
<name>Дополнительное поле заказа</name>
<entity_type>order</entity_type>
<required>false</required>
<value_type>unicode</value_type>
<default_value>значение тестового поля</default_value>
</custom_fields>
<custom_fields>
<external_id>line_field_id_123</external_id>
<name>Дополнительное поле позиции заказа</name>
<entity_type>line_order</entity_type>
<required>false</required>
<value_type>unicode</value_type>
<default_value>значение тестового поля</default_value>
</custom_fields>
<custom_line_statuses>
<external_id>status_id_123</external_id>
<name>Доставлен в пункт выдачи</name>
<type>in_process</type>
</custom_line_statuses>
<skip_triggers>true</skip_triggers>
<data>
<external_id>1234000</external_id>
<matching>email</matching>
<email>johndoe@example.com</email>
<endpoint>website</endpoint>
<tags>one</tags>
<tags>two</tags>
<status>delivered</status>
<delivery_cost>100</delivery_cost>
<total_price>1000</total_price>
<currency>USD</currency>
<create_time>2022-01-02T15:04:05.141Z</create_time>
<custom_fields>
<order_field_id_123>data</order_field_id_123>
</custom_fields>
<region>region_YnCrJj8Y1</region>
<lines>
<external_id>line_01</external_id>
<status>status_id_123</status>
<product>iphone_test_1</product>
<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>1</count>
<custom_fields>
<line_field_id_123>data</line_field_id_123>
</custom_fields>
</lines>
</data>
</xml>
Пример ответа JSON
- JSON
- XML
{
"error": 0,
"error_text": "",
"result": [
{
"error": 0,
"external_id": "1234000"
}
]
}