Xsolla-logoXsolla Developers
или
Личный кабинет

Создание цепочек наградServer-sideAdmin

post/v2/project/{project_id}/admin/reward_chain

Создает цепочку наград.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Example: 44056
Request Body schema: application/json
One of:

Цепочка наград.

required
(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

Вьетнамский

required
object
sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$

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

date_start
required
string <date-time>

Дата, когда начнет действовать ваша цепочка наград.

required
Array of objects
Array
required
(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

Вьетнамский

required
object
amount
required
integer

Цена уровня в призовых баллах.

required
Array of objects
Array
sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$

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

quantity
required
integer

Количество товаров.

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
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 — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

image_url
string or null

URL-адрес изображения.

is_enabled
required
boolean
Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
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

Вьетнамский

image_url
string or null

URL-адрес изображения.

is_always_visible
boolean
Default: true

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

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

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

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

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

Any 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

Вьетнамский

order
integer

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

(interval_type = weekly (object or null)) or (interval_type = monthly (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
{}
Response samples
application/json
{
  • "reward_chain_id": 10
}