Get list of promo code promotionsServer-sideAdmin
get/v2/project/{project_id}/admin/promocode
Gets the list of promo codes of a project.
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 |
Responses
200
List of promo codes was successfully received.
401
Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.
Request samples
- curl
- JavaScript
- Node.js
- Python
- C#
- Go
- Java
Response samples
- 200
- 401
application/json
{- "items": [
- {
- "external_id": "promocode_100_crystals",
- "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"
}, - "is_enabled": true,
- "bonus": [
- {
- "sku": "com.xsolla.elven_sword_1",
- "quantity": 1
}, - {
- "sku": "com.xsolla.elven_shield_1",
- "quantity": 2
}, - {
- "sku": "com.xsolla.elven_gloves_1",
- "quantity": 2
}
], - "redeem_user_limit": null,
- "redeem_total_limit": null,
- "redeem_code_limit": 1,
- "total_limit_state": null,
- "discount": null,
- "discounted_items": null
}, - {
- "external_id": "summer2021",
- "date_start": "2020-04-15T18:16:00+05:00",
- "date_end": "2020-04-25T18:16:00+05:00",
- "name": {
- "en-US": "Coupon name",
- "de-DE": "Gutscheintitel"
}, - "is_enabled": true,
- "bonus": [
- {
- "sku": "com.xsolla.diamonds_1",
- "quantity": 100
}
], - "redeem_user_limit": null,
- "redeem_total_limit": 100,
- "redeem_code_limit": null,
- "total_limit_state": {
- "available": 50,
- "reserved": 10,
- "used": 40
}, - "discount": {
- "percent": "10.99"
}, - "discounted_items": [
- {
- "sku": "com.xsolla.elven_sword_1",
- "discount": {
- "percent": "10.00"
}
}
], - "price_conditions": [
- {
- "operator": "ge",
- "value": "10.0000"
}, - {
- "operator": "le",
- "value": "50.0000"
}
], - "excluded_promotions": [
- 23,
- 45
]
}
], - "total_promotions_count": 2,
- "active_promotions_count": 2,
- "inactive_promotions_count": 0
}