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

Структура заказа (order data object)

Описание​

Объект order используется в API запросах, связанных с импортом заказов в маркет.

ПараметрТипПримерОбязательныйОписание
external_idstring"123456"ДаИдентификатор заказа
matchingstring"email"НетРежим поиска подписчика.
По умолчанию – email.

Для каждого типа матчинга в теле запроса необходимо передавать определенные поля. Подробнее об этих полях можно узнать здесь.
endpointstring"website"ДаДополнительный идентификатор точки продажи
tagsarray
["one","two"]
НетСписок тегов
statusstring"new"
"delivered"
"paid"
"canceled"
"part_refunded"		ДаИдентификатор статуса заказа
delivery_coststring"200"НетСтоимость доставки
total_pricestring"3000"ДаОбщая стоимость заказа.

Складывается из суммы каждой позиции в заказе и стоимости доставки.
currencystring"USD"ДаВалюта, в которой указана стоимость заказа.

Валюты настраиваются в интерфейсе платформы: Маркет → Настройки → Другое. Если в запросе передать валюту, которая не задана в платформе, произойдет ошибка.
create_timestring"2006-01-23T15:04:05.141Z"НетДата создания заказа (формат RFC3339)
update_timestring"2006-01-23T15:04:05.141Z"НетДата обновления заказа (формат RFC3339)
custom_fieldsobject
{
   "order_field_id_1": "data",
   "order_field_id_2": 123
}
НетЗначение дополнительных полей заказа.

"[id_доп_поля]": "[значение_доп_поля]"
regionstring"region_external_id"НетДополнительный идентификатор региона.

Создать регион и получить его идентификатор можно в интерфейсе платформы: Маркет → Настройки.
linesarray
[
   {
      "external_id": "7777",
      "product": "product_external_id",
      "base_price_per_item": "600",
      "min_price_per_item": "300",
      "final_price_per_item": "500", 
      "count": 5
   }
]
ДаДанные о позициях заказа. Минимум одна позиция. См. ниже.

JSON​

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

Lines object​

Описание​

Массив объектов lines содержит объекты с данными о позициях заказа. Один объект – одна позиция.

ПараметрТипПримерОбязательныйОписание
external_idstring"1235678"ДаДополнительный идентификатор позиции
statusstring"new"НетИдентификатор статуса позиции заказа:
  • delivering
  • processing
  • new
  • refunded
  • canceled
  • delivered
  • идентификатор кастомного статуса

skustringIPhone_Red_128GbНе должен присутствовать в запросе, если задан productДополнительный идентификатор SKU. Если товар представлен в виде продукта — укажите ID продукта, если же товар представлен в виде его разновидности — укажите только ID SKU.
productstringMP3_player_BassProНе должен присутствовать в запросе, если задан skuДополнительный идентификатор продукта
base_price_per_itemstring"600"ДаБазовая цена
min_price_per_itemstring"300"ДаМинимальная цена
final_price_per_itemstring"500"ДаКонечная цена
countint5ДаКоличество товара в позиции
custom_fieldsobject
{
   "imported": true,
   "lot_number": "39003"
}
НетЗначение дополнительных полей в позиции заказа

JSON​

[
    {
        "external_id": "1235678",
        "status": "0001",
        "sku": "sku_external_id",
        "base_price_per_item": "600",
        "min_price_per_item": "300",
        "final_price_per_item": "500",
        "count": 5,
        "custom_fields":
        {
            "line_field_id_2": 123,
            "line_field_id_2": "data"
        }
    }
]
Последнее обновление