Перейти к основному содержимому

Импорт заказа и статусов позиций

Описание

Импортирует в маркет заказ, метод оплаты и статусы позиций.

URL-адрес

Метод: POST

https://example.com/api/v1.1/market/orders/import

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен

Убедитесь, что для токена доступны роли, позволяющие работать с маркетом.
custom_fieldsarray of objects
[ 
   {
      "external_id": "1234",
      "name": "1234",
      "entity_type": "line_order",
      "required": false,
      "value_type": "unicode",
      "default_value": "data"
   }
]
НетСоздание дополнительных полей для следующих сущностей:
  • продукт
  • SKU
  • заказ
  • позиция заказа

custom_line_statusesarray of objects
[
   {
      "external_id": "1234",
      "name": "Поступил в пункт выдачи",
      "type": "in_process"
   }
]
НетКастомный статус позиции заказа.
Необходимо передать идентификатор статуса (external_id), его название (name) и тип (type).

Возможные значения поля type:
  • delivered (доставлен)
  • canceled (отменен)
  • refunded (возврат)
  • in_process (обрабатывается)

skip_triggersbooltrueНетПропустить запуск триггеров (по умолчанию – false)
dataarray of objects
[
   {
      "external_id": "123456",
      "matching":"email",
      "email":"johndoe@example.com"
      "endpoint": "endpoint_external_id",
      "status": "new",
      "total_price": "3000",
      "currency": "USD",
      "create_time": "2022-01-02T15:04:05.141Z",
      "lines": [
         {
            "external_id": "7777",
            "status": "0001",
            "product": "product_external_id",
            "base_price_per_item": "600",
            "min_price_per_item": "300",
            "final_price_per_item": "500",
            "count": 5
         }
      ]
   }
]
ДаДанные о заказе.
Подробнее.

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

{
"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"
}
}
]
}
]
}

Пример ответа JSON

{
"error": 0,
"error_text": "",
"result": [
{
"error": 0,
"external_id": "1234000"
}
]
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
resultarrayИдентификаторы импортированных заказов