Xsolla-logo

Создание акции с промокодамиServer-sideAdmin

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

Создает акцию с промокодами.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

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

Example: 44056
Request Body schema: application/json
external_id
required
string
Default: "coupon_external_id"

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

required
object
Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.

property name*
additional property
string
Array of objects or null
Array
quantity
number
Default: 1

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

sku
string
Default: "elven_shield"

Артикул товара.

date_end
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

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

date_start
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

Дата, когда начнется ваша акция.

object or null
percent
string or null
Default: "10.00"

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

Array of objects or null

Список товаров, на которые действует скидка по промокоду.

Array
sku
required
string
Default: "elven_shield"

Артикул товара.

required
object
percent
required
string
Default: "10.00"

Процент скидки.

Цена товара в корзине будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.

redeem_code_limit
integer or null
Default: 10

Количество погашений по коду.

redeem_total_limit
integer or null
Default: 10

Ограничивает общее количество купонов.

redeem_user_limit
integer or null
Default: 10

Ограничивает общее количество купонов, погашаемых одним пользователем.

Responses
201

Промокод успешно создан.

401

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

422

Неверный запрос.

Request samples
application/json
{
  • "bonus": [
    ],
  • "date_end": "2020-04-15T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "discount": {
    },
  • "discounted_items": [
    ],
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "redeem_code_limit": 10,
  • "redeem_total_limit": 10,
  • "redeem_user_limit": 10
}
Response samples
application/json
{
  • "coupon_id": "coupon_external_id"
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2024 Xsolla Inc.