This API allows getting any kind of sellable items or specific item.
/
Delete bonus promotion
Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Download OpenAPI description
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/shop-builder/
https://store.xsolla.com/api/
Personalized catalog
This API allows to specify rules for user attributes. If the user meets all conditions for a concrete rule, personalized items will be shown.
For personalized promotions see Promotions section.
To pass attributes before a purchase, you can use Xsolla Login API or pass them into user.attributes property while generating token using Pay Station API.
Operations
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/promotion/111425/bonusBonus promotion was successfully received.
Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.
Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.
Example: {"en-US":"Summer season bonus","de-DE":"Sommersaison Bonus"}
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.
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items
Conditions for validating user attributes. Determine promotion availability based on whether user attributes match all specified conditions.
List of promotion IDs to exclude when applying this promotion.
Example: [12, 789]
Example: [12,789]
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.
Response
application/json
{ "id": 1, "promotion_periods": [ { … } ], "name": { "en-US": "New Year Bonus", "de-DE": "Neujahrsbonus" }, "is_enabled": true, "condition": [ { … }, { … } ], "bonus": [ { … }, { … }, { … } ], "limits": { "per_user": { … }, "per_item": null, "recurrent_schedule": { … } }, "excluded_promotions": [ 23, 45 ], "price_conditions": [ { … }, { … } ] }
Request
Deletes bonus promotion. The deleted promotion:
- Disappears from the list of promotions set up in your project.
- Is no longer applied to the item catalog and the cart. User can’t get bonus items with this promotion.
After deletion, the promotion can’t be restored.
Security
basicAuth
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/promotion/111425/bonus