Skip to content
/
Set promotion limit for s...

Shop Builder API (2.0.0)

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
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/shop-builder/
https://store.xsolla.com/api/

Admin

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

Admin

Operations

Catalog

Operations

Cart (client-side)

Operations

Cart (server-side)

Operations

Payment (client-side)

Operations

Payment (server-side)

Operations

Order

Operations

Free items

Operations

Webhooks

Operations

Pre-Orders

Operations

Merchant

Operations

Catalog

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

Operations

Common regions

Operations

Catalog

Operations

Entitlement

Operations

Admin

Operations

Common

Operations

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

Admin

Operations

Catalog

Operations

Virtual payment

Operations

Management

Operations

Increase promotion limit for specified userServer-sideAdmin

Request

Increases the remaining number of times the specified user can use the promotion within the limit applied.

User limit API allows you to limit the number of times users can use a promotion. For configuring the user limit itself, go to the Admin section of the desired promotion type:

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
Bodyapplication/json
userobject(User-limit_user)required
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$required

User external ID.

availableinteger(User-limit_available)>= 1required

Remaining number of items or promotion uses available to the user within the limit applied.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    },
    "available": 1
  }'

Responses

Promotion limits for a user were successfully received.

Bodyapplication/json
per_userobject
Response
application/json
{
  "per_user": {
    "total": 10,
    "available": 9
  }
}

Set promotion limit for specified userServer-sideAdmin

Request

Sets the number of times the specified user can use a promotion within the limit applied after it was increased or decreased.

User limit API allows you to limit the number of times users can use a promotion. For configuring the user limit itself, go to the Admin section of the desired promotion type:

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
Bodyapplication/json
userobject(User-limit_user)required
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$required

User external ID.

availableinteger(User-limit_available_flexible)>= 0required

Remaining number of items or promotion uses available to the user within the limit applied.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    },
    "available": 0
  }'

Responses

Promotion limits for a user were successfully received.

Bodyapplication/json
per_userobject
Response
application/json
{
  "per_user": {
    "total": 10,
    "available": 9
  }
}

Decrease promotion limit for specified userServer-sideAdmin

Request

Decreases the remaining number of times the specified user can use a promotion within the limit applied.

User limit API allows you to limit the number of times users can use a promotion. For configuring the user limit itself, go to the Admin section of the desired promotion type:

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
Bodyapplication/json
userobject(User-limit_user)required
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$required

User external ID.

availableinteger(User-limit_available)>= 1required

Remaining number of items or promotion uses available to the user within the limit applied.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    },
    "available": 1
  }'

Responses

Promotion limits for a user were successfully received.

Bodyapplication/json
per_userobject
Response
application/json
{
  "per_user": {
    "total": 10,
    "available": 9
  }
}

Admin

Operations

Client

Operations

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations