Gets all rules applying to user attributes.
/
Get list of catalog filte...
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
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/v2/project/{project_id}/admin/user/attribute/rule
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/attribute/rule
- 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/v2/project/44056/admin/user/attribute/rule?limit=50&offset=0&is_enabled=0'Response
application/json
{ "items": [ { … } ], "total_items_count": 20, "has_more": true }
Path
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Readable name of a rule. Used to display a rule in Publisher Account.
Whether the item is displayed to unauthorized users. If true, the item is displayed to the unauthorized user regardless of catalog display rules. false by default.
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsrequired
Conditions for validating user attributes. Determine item availability in the catalog based on whether user attributes match all specified conditions.
One of:
attribute_conditions[].attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$required
User attribute code.
User attribute type.
Value"string"
attribute_conditions[].operatorstring(user-attribute_conditions_properties_operator_string)required
Type of operation performed by condition. For string attribute type.
| Enum Value | Description |
|---|---|
| eq | Equals |
| ne | Not equals |
attribute_conditions[].valuestring(user-attribute_conditions_properties_value)<= 255 charactersrequired
Condition value which user attribute value will be compared to. Type depends on attribute type.
Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/user/attribute/rule
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/attribute/rule
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/user/attribute/rule \
-H 'Content-Type: application/json' \
-d '{
"name": "Ork race armor rule",
"is_enabled": true,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"items": [
{
"item_id": 1
}
],
"is_satisfied_for_unauth": false
}'Response
application/json
{ "rule_id": 1 }
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/v2/project/{project_id}/admin/user/attribute/rule/all
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/attribute/rule/all
- 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/v2/project/44056/admin/user/attribute/rule/allResponse
application/json
{ "items": [ { … }, { … } ] }