This API allows getting any kind of sellable items or specific item.
- Get unique catalog offer promotion
Create unique catalog offer promotion
Get list of unique catalog offer promotions
Update unique catalog offer promotion
Delete unique catalog offer promotion
Activate unique catalog offer promotion
Deactivate unique catalog offer promotion
Create unique catalog offer code
Get unique catalog offer codes
Generate unique catalog offer codes
Get unique catalog offer...
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
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
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.
Default {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
Example: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
A list of items SKU that are available after using the unique catalog offer.
Example: ["booster_mega_1"]
Limits total numbers of coupons.
Default 10
Example: 10
Limits total numbers of coupons redeemed by single user.
Default 10
Example: 10
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1 \
-H 'Content-Type: application/json' \
-d '{
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Offer",
"de-DE": "Neujahrsangebot"
},
"items": [
"elven_sword",
"elven_boots"
]
}'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/unique_catalog_offer/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- 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/unique_catalog_offer/coupon_44056_1Unique catalog offer was successfully received.
Unique promotion ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
Default "coupon_external_id"
Example: "coupon_external_id"
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.
Default {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
Example: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
A list of items SKU that are available after using the unique catalog offer.
Example: ["booster_mega_1"]
Limits total numbers of coupons.
Default 10
Example: 10
Limits total numbers of coupons redeemed by single user.
Default 10
Example: 10
Number of redemptions per code.
Default 10
Example: 10
Response
application/json
{ "external_id": "secret_shop", "promotion_periods": [ { … }, { … } ], "name": { "en-US": "Secret shop", "ru-RU": "Секретный магазин" }, "items": [ "helmet", "sword", "shield" ], "is_enabled": true, "redeem_user_limit": 1, "redeem_total_limit": 100, "redeem_code_limit": 1, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
Request
Deletes unique catalog offer 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 buy 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/unique_catalog_offer/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- 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/unique_catalog_offer/coupon_44056_1