Xsolla-logo

Create promo code promotion

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

Creates a promo code promotion.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

Project ID.

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

Unique promotion ID. The external_id may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

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

Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.

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

Date when your promotion will be started.

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

Date when your promotion will be finished. Can be null. If date_end is null, promotion will be unlimited by time.

Array of objects or null
Array
sku
string
Default: "elven_shield"

Item SKU.

quantity
number
Default: 1

Item quantity.

redeem_total_limit
integer or null
Default: 10

Limits total numbers of coupons.

redeem_user_limit
integer or null
Default: 10

Limits total numbers of coupons redeemed by single user.

redeem_code_limit
integer or null
Default: 10

Number of redemptions per code.

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

Percent discount. The price of cart will be decreased using a value calculated by using this percent and then rounded to 2 decimal places.

Array of objects or null

List of items that are discounted by a promo code.

Array
sku
required
string
Default: "elven_shield"

Item SKU.

required
object
percent
required
string
Default: "10.00"

Percent discount.

The price of cart item will be decreased using a value calculated by using this percent and then rounded to 2 decimal places.

Responses
201

Promo code was successfully created.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

422

Invalid request.

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