Skip to content

Overview

  • 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/
Operations

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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Catalog

This API allows getting any kind of sellable items or specific item.

Operations
Operations
Operations
Operations
Operations
Operations

Get all promotion listServer-sideAdmin

Request

Gets the list of promotions of a project.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
Query
limitinteger>= 1

Limit for the number of elements on the page.

Example: limit=50
offsetinteger>= 0

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
enabledinteger

Filter elements by is_enabled flag.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/promotion?limit=50&offset=0&enabled=0'

Responses

List of promotions was successfully received.

Bodyapplication/json
promotionsArray of objects(Promotions_200-get-promotion-model)
total_promotions_countinteger(total_promotions_count)

Total number of promotions.

active_promotions_countinteger(active_promotions_count)

Number of active promotions.

inactive_promotions_countinteger(inactive_promotions_count)

Number of deactivated promotions.

Response
application/json
{ "promotions": [ {}, {}, {}, {}, {} ], "total_promotions_count": 5, "active_promotions_count": 3, "inactive_promotions_count": 2 }

Activate promotionServer-sideAdmin

Request

Activates a promotion.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
promotion_idintegerrequired

Promotion ID. Unique promotion identifier within the project.

Example: 111425
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/promotion/111425/activate

Responses

Promotion was successfully activated.

Response
No content

Deactivate promotionServer-sideAdmin

Request

Deactivates a promotion.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
promotion_idintegerrequired

Promotion ID. Unique promotion identifier within the project.

Example: 111425
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/promotion/111425/deactivate

Responses

Promotion was successfully deactivated.

Response
No content

Coupons

This API allows to you to manage coupons.

Operations

Promo codes

This API allows to manage promo codes.

Operations

Unique catalog offers

This API allows to you to manage unique catalog offers.

Operations

Discounts

This API allows to you to manage discount promotions.

Operations

Bonuses

This API allows to manage bonus promotions.

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations