get
/merchant/projects/{project_id}/store/promocode/{external_id}
Gets a specified promo code.
Promo code can be used for increasing sales and players loyalty. After redeeming a promo code, the user will get free items and/or the price of cart will be decreased.
Authorization
basic
Request Parameters
2 Path Parameters
Responses
Promo code was successfully received.
1 Example
Schema
external_id
string
Unique coupon ID. The external_id
may only contain lowercase Latin alphanumeric characters, dashes, and underscores.
1 validation
date_start
string or null
Date when you promotion will be started.
2 validations
date_end
string or null
Date when you promotion will be finished. Can be null. If date_end
is null, promotion will be unlimited by time.
2 validations
name
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.
2 validations
bonus
array[object] or null
is_enabled
boolean
1 validation
redeem_total_limit
integer or null
Limits total numbers of coupons.
2 validations
redeem_user_limit
integer or null
Limits total numbers of coupons redeemed by single user.
2 validations
discount
object or null
1 validation
Send a Test Request
GET
Send requests directly from the browser (CORS must be enabled)
Path Params
project_id
external_id
$$.env
2 variables not set
username
password