Создание акции с купонами

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

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

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

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"

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

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": [{"quantity": 1,
"sku": "elven_shield"
}
],
"date_end": "2020-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "coupon_external_id",
"name": {"de-DE": "Gutscheintitel",
"en-US": "Coupon title"
},
"redeem_code_limit": 10,
"redeem_total_limit": 10,
"redeem_user_limit": 10
}

Response samples

application/json

{"external_id": "coupon_external_id"
}