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

Create attribute valueServer-sideAdmin

Request

Creates an attribute value.

Attention

All projects have the limitation to the number of attribute values. The default and maximum value is 20 values per attribute.
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
external_idstringrequired

Attribute external ID.

Example: attribute_id
Bodyapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$required

Unique value ID for an attribute. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.

Example: "attribute_value"
valueobject(value-name)required

Object with localizations of the value's name. Keys are specified in ISO 3166-1.

Default {"en":"Strategy","de":"Strategie"}
Example: {"en":"Strategy","de":"Strategie"}
value.​property name*stringadditional property
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/attribute/attribute_id/value \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "en": "Sword",
      "de": "Schwert"
    }
  }'

Responses

Attribute value was successfully created.

Bodyapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

Unique value ID for an attribute. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.

Example: "attribute_value"
Response
application/json
{ "external_id": "rpg" }

Delete all values of attributeServer-sideAdmin

Request

Deletes all values of the attribute.

Notice

If you delete an attribute's value, all connections between the attribute and items will be lost. To change the attribute value for an item, use the Update attribute value API call instead of deleting the value and creating a new one.
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
external_idstringrequired

Attribute external ID.

Example: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/attribute/attribute_id/value

Responses

Attribute values was successfully deleted.

Response
No content

Update attribute valueServer-sideAdmin

Request

Updates an attribute values.

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
value_external_idstring^[-_\.\d\w]+$required

Attribute value external ID.

Example: value_id
external_idstringrequired

Attribute external ID.

Example: attribute_id
Bodyapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$required

Unique value ID for an attribute. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.

Example: "attribute_value"
valueobject(value-name)required

Object with localizations of the value's name. Keys are specified in ISO 3166-1.

Default {"en":"Strategy","de":"Strategie"}
Example: {"en":"Strategy","de":"Strategie"}
value.​property name*stringadditional property
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/attribute/attribute_id/value/value_id \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "en": "Sword",
      "de": "Schwert"
    }
  }'

Responses

Attribute value was successfully updated.

Response
No content

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

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