Create coupon promotion

Create coupon promotionServer-sideAdmin

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

Creates a coupon promotion.

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

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.

Responses

201

Coupon 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": {"en-US": "Coupon title",
"de-DE": "Gutscheintitel"
},
"bonus": [{"sku": "elven_shield",
"quantity": 1
}
],
"redeem_total_limit": 10,
"redeem_user_limit": 10,
"redeem_code_limit": 10
}

Response samples

application/json

{"coupon_id": "coupon_external_id"
}