Создание цепочки предложений

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Двухбуквенные строчные языковые коды.

ar	string or null Арабский
bg	string or null Болгарский
cn	string or null Китайский упрощенный
cs	string or null Чешский
de	string or null Немецкий
en	string or null Английский
es	string or null Spanish (Spain)
fr	string or null Французский
he	string or null Иврит
id	string or null Индонезийский
it	string or null Итальянский
ja	string or null Японский
km	string or null Кхмерский
ko	string or null Корейский
lo	string or null Лаосский
my	string or null Бирманский
ne	string or null Непальский
ph	string or null Филиппинский
pl	string or null Польский
pt	string or null Португальский
ro	string or null Румынский
ru	string or null Русский
th	string or null Тайский
tr	string or null Турецкий
tw	string or null Китайский традиционный
vi	string or null Вьетнамский

date_start

required

string <date-time>

Дата начала действия цепочки предложений.

required

Array of objects

Array

step_number

required

integer >= 1

Номер уровня.

is_free

required

boolean

Указывает, является ли уровень цепочки предложений бесплатным:

Если true — награду необходимо запросить, используя метод Получение награды за уровень цепочки предложений.
Если false — награду необходимо приобрести, используя метод Создание заказа на награду за уровень цепочки предложений.

required

Array of objects non-empty

Array (non-empty)

sku required	string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$ Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
quantity required	integer >= 1 Количество товаров в вознаграждении для этого уровня цепочки.
order	integer or null >= 0 Заказ на вознаграждение за уровень цепочки предложений.

is_enabled

required

boolean

Array of type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

Условия для проверки атрибутов пользователя. Определяют доступность цепочки на основе соответствия атрибутов пользователя всем указанным условиям.

Array ([ 1 .. 100 ] items)

One of:

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Код атрибута пользователя.

operator

required

string

Тип операции, выполняемой по условию. Для типа атрибута string.

Enum:	Description
eq	Равно
ne	Не равно

value

required

string <= 255 characters

Значение условия, с которым будет сравниваться значение атрибута пользователя. Тип зависит от типа атрибута.

type

required

string

Тип атрибута пользователя.

Value: "string"

can_be_missing

boolean

Считается ли условие выполненным, если этот атрибут отсутствует в атрибутах пользователя. Передайте true, чтобы показывать товар пользователям, у которых нет этого атрибута. Пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, не увидят товар. false — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

date_end

string or null <date-time>

Дата окончания срока действия цепочки предложений. Может быть null. Если date_end равен null, цепочка предложений будет бессрочной.

(two-letter (object or null)) or (five-letter (object or null))

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Двухбуквенные строчные языковые коды.

ar	string or null Арабский
bg	string or null Болгарский
cn	string or null Китайский упрощенный
cs	string or null Чешский
de	string or null Немецкий
en	string or null Английский
es	string or null Spanish (Spain)
fr	string or null Французский
he	string or null Иврит
id	string or null Индонезийский
it	string or null Итальянский
ja	string or null Японский
km	string or null Кхмерский
ko	string or null Корейский
lo	string or null Лаосский
my	string or null Бирманский
ne	string or null Непальский
ph	string or null Филиппинский
pl	string or null Польский
pt	string or null Португальский
ro	string or null Румынский
ru	string or null Русский
th	string or null Тайский
tr	string or null Турецкий
tw	string or null Китайский традиционный
vi	string or null Вьетнамский

is_always_visible

boolean

Default: true

Отображается ли цепочка наград всем пользователям:

Если true — цепочка всегда отображается, независимо от авторизации пользователя и его атрибутов.
Если false — цепочка отображается, только если не найдено ни одной персонализированной цепочки. Например, если пользователь не авторизован или его атрибуты не соответствуют ни одной персонализированной цепочке.

Применяется только в контексте персонализации цепочек и используется, если массив attribute_conditions не передан.

order

integer

Определяет порядок расположения.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = hourly (object or null))

Интервал сброса цепочки предложений.

One of:

Еженедельный сброс цепочки предложений.

interval_type required	string Частота сброса цепочки предложений. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Время сброса цепочки предложений в указанном часовом поясе (с округлением до часов). Например, время сброса установлено на 01:00 по часовому поясу Куала-Лумпура (GMT+8), значение параметра `time` будет `01:00:00+08:00`.
day_of_week required	integer [ 1 .. 7 ] День недели, когда происходит сброс, где `1` — понедельник, `7` — воскресенье.

Responses

201

Цепочка предложений успешно создана.

401

Данные для базовой аутентификации не переданы или ошибочны. Убедитесь, что использовали базовую аутентификацию и проверьте правильность учетных данных.

422

Некорректная конфигурация цепочки предложений.

Request samples

application/json

{"date_end": null,
"date_start": "2023-04-15T18:16:00+05:00",
"description": {"de": "Eine kurze Beschreibung einer regulären Angebotskette",
"en": "A short description of a regular offer chain",
"fr": "Une brève description d'une chaîne d'offres régulière",
"it": "Una breve descrizione di una catena di offerte regolare",
"ru": "Краткое описание обычной цепочки предложений"
},
"is_always_visible": true,
"is_enabled": true,
"name": {"de": "Neue Angebotskette",
"en": "New offer chain",
"fr": "Nouvelle chaîne d'offres",
"it": "Nuova catena di offerte",
"ru": "Новая цепочка предложений"
},
"order": 4,
"recurrent_schedule": null,
"steps": [{"is_free": false,
"items": [{"quantity": 2,
"sku": "chain_step_1_paid_bundle_sku"
}
],
"step_number": 1
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "chain_step_2_free_virtual_good_sku"
}
],
"step_number": 2
},
{"is_free": false,
"items": [{"quantity": 5,
"sku": "chain_step_3_paid_virtual_currency_package_sku"
}
],
"step_number": 3
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "chain_step_4_free_bundle_sku"
}
],
"step_number": 4
}
]
}

Response samples

application/json

{"offer_chain_id": 10
}