Описание

Объект 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-02T15:04:05.141Z"Нет

Дата создания заказа

Формат RFC3339

update_timestring"2006-01-02T15: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": "0001",
				"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
  • идентификатор кастомного статуса
skustringsku_external_idНе должен присутствовать в запросе, если задан productИдентификатор SKU
productstringproduct_external_idНе должен присутствовать в запросе, если задан skuИдентификатор продукта
base_price_per_itemstring"600"ДаБазовая цена
min_price_per_itemstring"300"ДаМинимальная цена
final_price_per_itemstring"500"ДаКонечная цена
countint5ДаКоличество товара в позиции
custom_fieldsobject
{
	"line_field_id_2": 123,
	"line_field_id_2": "data"
}
НетЗначение дополнительных полей в позиции заказа

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"
		}
	}
]
  • No labels