Create bonus promotion

Create bonus promotionServer-sideAdmin

post/v2/project/{project_id}/admin/promotion/bonus

Creates the bonus promotion.

Promotion adds free bonus items to the purchase made by a user. The promotion can be applied to every purchase within a project or to a purchase that includes particular items.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

Request Body schema: application/json

required

Array of objects or null

Set of items required to be included in the purchase for applying a promotion. If this parameters is null, a promotion will be applied to any purchases within a project.

Array

sku	string Default: "elven_sword" Item SKU.

required

Array of objects or null

Array

sku	string Default: "elven_shield" Item SKU.
quantity	number Default: 1 Item quantity.

required

object

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

integer

Promotion ID. Unique promotion identifier within the project.

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 type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

One of:

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

User attribute code.

operator

required

string

Type of operation performed by condition. For string attribute type.

Enum:	Description
eq	Equals
ne	Not equals

value

required

string <= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

type

required

string

User attribute type.

Value: "string"

can_be_missing

boolean

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

object

Promotion limits.

per_user

integer or null

Promotion limitation for a separate user.

object or null

Limit refresh period.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)

One of:

Daily type of user limits refresh.

interval_type required	string Recurrent refresh period. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Time of limit refresh in the desired time zone (rounding to hours).

Array of objects or null

Array of objects with conditions that set the price range for applying the promotion.
The promotion applies only to items whose price meets all the conditions in the array. If you pass this array, set the value of the condition object to null.

Array

operator

required

string

Comparison operator for setting the price range for applying the promotion.

Enum:	Description
ge	Greater or equal
gt	Greater than
le	Less or equal
lt	Less than
eq	Equals
ne	Not equals

value

required

string^\\d+(\\.\\d{1,4})?$

Value for determining the price range for applying the promotion.

excluded_promotions

Array of integers

List of promotion IDs to exclude when applying this promotion.
Example: [12, 789]

Responses

201

Promotion 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

{"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2020-04-25T18:16:00+05:00",
"name": {"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"condition": [{"sku": "elven_boots"
},
{"sku": "elven_knife"
}
],
"bonus": [{"sku": "elven_sword",
"quantity": 1
},
{"sku": "elven_shield",
"quantity": 2
},
{"sku": "elven_gloves",
"quantity": 2
}
]
}

Response samples

application/json

{"promotion_id": 2384756
}