Создайте цепочку вознаграждений

Создайте цепочку вознаграждений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

required

object

Объект с локализациями для названия товара. Двухбуквенный код языка в нижнем регистре.

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
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	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

object

Объект с локализациями для названия товара. Двухбуквенный код языка в нижнем регистре.

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
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	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 Количество товара.

image_url

string or null

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

is_enabled

required

boolean

date_end

string or null <date-time>

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

object

Объект с локализациями для описания товара. Двухбуквенный код языка в нижнем регистре.

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
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	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 изображения.

object

Объект с локализациями для длинного описания товара. Двухбуквенный код языка в нижнем регистре.

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
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	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

{"date_end": "2021-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"description": {"en": "Reward chain description"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Reward chain long description"
},
"name": {"en": "Reward chain"
},
"order": 1,
"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": "item_sku_1"
},
{"quantity": 1,
"sku": "item_sku_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": "item_sku_3"
},
{"quantity": 1,
"sku": "item_sku_4"
}
]
}
],
"value_point": {"sku": "value_point_sku"
}
}

Response samples

application/json

{"reward_chain_id": 10
}