Skip to content
/
Get information about ups...

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

Admin

Operations

Client

Operations

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Get information about upsell in projectServer-sideAdmin

Request

Retrieves the information about upsell in project: whether it's enabled, type of upsell, and the SKU list of items that are a part of this upsell.

Security
XsollaLoginUserJWT
Path
project_idintegerrequired

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

Example: 44056
curl -i -X GET \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The list of configuration details and items used for upsell in the project.

Bodyapplication/jsonArray [
is_enabledboolean

Whether upsell is enabled for the project.

Example: true
typestring

The type of upsell.

Enum"fixed_list""most_sellable""only_promotions"
Example: "fixed_list"
itemsArray of objects

The list of items SKU that are a part of the upsell in the project.

Example: [{"item_id":1,"sku":"com.xsolla.booster_mega_1","name":{"en":"Item's name","de":"Name des Artikels"},"type":"virtual_good"}]
]
Response
application/json
[
  {
    "is_enabled": true,
    "type": "fixed_list",
    "items": [ … ]
  }
]

Create upsellServer-sideAdmin

Request

Creates an upsell for a project.

Security
XsollaLoginUserJWT
Path
project_idintegerrequired

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

Example: 44056
Bodyapplication/json
One of:

Upsell type.

typestringrequired
Value"fixed_list"
Example: true
is_enabledboolean(is_enabled)required
Example: true
itemsArray of stringsrequired

Array of items SKU.

Default null
Example: ["game_sku"]
curl -i -X POST \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "type": "fixed_list",
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ]
  }'

Responses

Upsell has been created for the project.

Response
No content

Update upsellServer-sideAdmin

Request

Update an upsell for a project.

Security
XsollaLoginUserJWT
Path
project_idintegerrequired

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

Example: 44056
Bodyapplication/json
One of:

Upsell type.

typestringrequired
Value"fixed_list"
Example: true
is_enabledboolean(is_enabled)required
Example: true
itemsArray of stringsrequired

Array of items SKU.

Default null
Example: ["game_sku"]
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "type": "fixed_list",
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ]
  }'

Responses

Upsell has been updated for the project.

Response
No content

Client

Operations

Admin

Operations