This API allows getting any kind of sellable items or specific item.
/
Get daily reward
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
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
One of:
A daily reward for calendar_hard type.
Daily reward type that determines when users can claim rewards.
| Enum Value | Description |
|---|---|
| calendar_hard | Unlocks the next step reward every 24 hours. Any unclaimed step rewards are permanently lost once the next step reward becomes available. |
| rolling_skippable | Unlocks the next step reward every 24 hours based on |
| rolling_unskippable | Unlocks the next step reward every 24 hours based on |
Date when your daily reward starts.
Example: "2020-04-15T18:16:00+05:00"
Whether the daily reward is recurrent. If true, the daily reward will automatically reset after the end date. The next start_date and end_date schedule is based on the number of daily reward steps and the initial time set on start_date.
Default false
Example: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)required
Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
One of:
Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
One of:
Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
Example: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/daily_chain
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain
- 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/daily_chain \
-H 'Content-Type: application/json' \
-d '{
"name": {
"en": "New daily reward",
"ru": "Новая ежедневная награда"
},
"description": {
"en": "New daily reward short description"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"is_enabled": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "vg_enabled_shown_in_store_1",
"quantity": 2
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 2
}
]
},
{
"step_number": 3,
"items": [
{
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 2
}
]
},
{
"step_number": 4,
"items": [
{
"sku": "vg_enabled_shown_in_store_1",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 1
}
]
},
{
"step_number": 6,
"items": [
{
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 1
}
]
}
],
"type": "calendar_hard"
}'Response
application/json
{ "daily_chain_id": 10 }
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/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- 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/daily_chain/id/101The daily reward data was successfully retrieved.
Daily reward type that determines when users can claim rewards.
| Enum Value | Description |
|---|---|
| calendar_hard | Unlocks the next step reward every 24 hours. Any unclaimed step rewards are permanently lost once the next step reward becomes available. |
| rolling_skippable | Unlocks the next step reward every 24 hours based on |
| rolling_unskippable | Unlocks the next step reward every 24 hours based on |
Discriminator
Date when your daily reward starts.
Example: "2020-04-15T18:16:00+05:00"
Whether the daily reward is recurrent. If true, the daily reward will automatically reset after the end date. The next start_date and end_date schedule is based on the number of daily reward steps and the initial time set on start_date.
Default false
Example: true
Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
One of:
Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
One of:
Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
Date when your daily reward ends. Can be null. Setting the type calendar_hard will automatically set this date based on number of steps added, so you can leave this as null.
Example: "2020-04-15T18:16:00+05:00"
It is the number of steps configured in the daily reward. Each step here signify a day in the daily reward.
Example: 3
Response
application/json
{ "id": 3, "name": { "en": "Daily reward", "ru": "Ежедневная награда" }, "description": { "en": "Daily reward short description" }, "date_start": "2023-04-15T18:16:00+05:00", "date_end": "2025-04-25T18:16:00+05:00", "order": 1, "is_recurrent": false, "number_of_steps": 3, "steps": [ { … }, { … }, { … } ], "is_enabled": true, "type": "calendar_hard" }
Path
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
One of:
A daily reward for calendar_hard type.
Daily reward type that determines when users can claim rewards.
| Enum Value | Description |
|---|---|
| calendar_hard | Unlocks the next step reward every 24 hours. Any unclaimed step rewards are permanently lost once the next step reward becomes available. |
| rolling_skippable | Unlocks the next step reward every 24 hours based on |
| rolling_unskippable | Unlocks the next step reward every 24 hours based on |
Date when your daily reward starts.
Example: "2020-04-15T18:16:00+05:00"
Whether the daily reward is recurrent. If true, the daily reward will automatically reset after the end date. The next start_date and end_date schedule is based on the number of daily reward steps and the initial time set on start_date.
Default false
Example: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)required
Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
One of:
Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
One of:
Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.
Daily reward step unique identifier. Specify it during update to retain user's progress for this step.
Example: 10
Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
Example: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/daily_chain/id/101 \
-H 'Content-Type: application/json' \
-d '{
"name": {
"en": "Updated daily reward",
"ru": "Обновленная ежедневная награда"
},
"description": {
"en": "Updated daily reward description"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"is_enabled": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "vg_enabled_shown_in_store_1",
"quantity": 1
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "vg_enabled_shown_in_store_2",
"quantity": 1
}
]
},
{
"step_id": 10,
"step_number": 3,
"items": [
{
"sku": "vg_not_shown_in_store",
"quantity": 1
}
]
},
{
"step_id": 8,
"step_number": 4,
"items": [
{
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 1
}
]
}
],
"type": "calendar_hard"
}'