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

или

Личный кабинет

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

post/v3/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 товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

required

Array of objects

Периоды действия цепочки наград. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.

Array

date_from required	string <date-time> Дата начала действия указанной цепочки наград.
date_until	string or null <date-time> Дата окончания действия указанной цепочки наград. Может быть `null`, только если указан один период действия.

required

Array of objects

Array

required

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

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_\-–.]*$

quantity

required

integer

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

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 — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

image_url

string or null

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

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

(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 не передан.

is_reset_after_end

boolean

Default: false

Нужно ли сбрасывать цепочку наград (призовые баллы и прогресс всех пользователей) после даты ее окончания:

Если true, цепочка наград будет сброшена после даты окончания.
Если false, цепочка наград не будет сброшена после даты окончания.

Внимание

Не может быть true, если:

В recurrent_schedule задан период регулярного обновления.
В periods.date_until передано null.

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

{"clan_type": "guild",
"description": {"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Clan reward chain long description."
},
"name": {"en": "Clan reward chain"
},
"order": 1,
"periods": [{"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"popup_header": {"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"popup_instruction": {"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"recurrent_schedule": {"day_of_week": 1,
"interval_type": "weekly",
"time": "01:00:00+08:00"
},
"steps": [{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "First step of the reward chain"
},
"price": {"amount": 10
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_1"
},
{"quantity": 1,
"sku": "com.xsolla.item_2"
}
]
},
{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "Second step of the reward chain"
},
"price": {"amount": 15
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_3"
},
{"quantity": 1,
"sku": "com.xsolla.item_4"
}
]
}
],
"value_point": {"sku": "com.xsolla.clan_value_point_1"
}
}

Response samples

application/json

{"reward_chain_id": 10
}