Show bundle in catalog

Admin
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Personalized catalog
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Get bundleServer-sideAdmin

Request

Gets the bundle within a project for administration.

Note

Do not use this endpoint for building a store catalog.

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

skustringrequired

Bundle SKU.

Example: kg_1

curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/items/bundle/sku/kg_1

Responses

The specified bundle was successfully received.

Bodyapplication/json

item_idinteger(Bundles_item_id)[ 1 .. 255 ] characters

Internal unique item ID.

Example: 1

skustring(Bundles_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.

Example: "bundle_1"

name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

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.

attributesArray of objects(Bundles_admin-attributes)

List of attributes.

Example: [{"external_id":"attribute_external_id","name":{"en":"Attribute name","de":"Attributname"},"values":[{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]}]

typestring(Bundles_type)

Type of item.

Example: "bundle"

bundle_typestring(bundle_type)

Bundle type. Returned if item type is a bundle.

Enum"standard""virtual_currency_package""partner_side_content"

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.

long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

Object with localizations for long description of item. 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 variants 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.

Any of:

Object with localizations for long description of item. 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 variants 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.

image_urlstring or null(Bundles_image_url)

Image URL.

Example: "https://image.example.com"

is_freeboolean(value-is_free)

If true, the item is free.

Default false

Example: false

groupsArray of objects(Bundles_groups_response)

Groups the item belongs to.

Default []

Example: [{"external_id":"horror","name":{"en":"Horror"}}]

pricesArray of objects(Bundles_prices)

Prices in real currencies.

virtual_pricesArray of objects(Bundles_admin-response-virtual_price)

media_listArray of objects or null

Bundle's additional assets.

Example: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]

orderinteger(Bundles_order)

Bundle's order priority in the list.

Default 1

Example: 1

is_enabledboolean(Bundles_is_enabled)

If disabled, the item can't be found and purchased.

Default true

Example: true

is_show_in_storeboolean(Bundles_is_show_in_store)

Item is available for purchase.

Default false

Example: true

regionsArray of objects(Bundles_admin-regions)

contentArray of objects(Bundles_admin_content_response)

limitsobject or null(admin-item-limit-response)

Item limits.

periodsArray of objects(item-periods-response)

Item sales period.

custom_attributesobject(json)(item-custom-attributes-response)

A JSON object containing item attributes and values.

total_content_priceobject or null(Bundles_total_content_price)

Sum of the bundle content prices.

Response

application/json

{
  "item_id": 610316,
  "sku": "com.xsolla.EmpireBundle_1",
  "name": {
    "en": "Empire bundle"
  },
  "type": "bundle",
  "description": {
    "en": "Empire bundle with items"
  },
  "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
  "long_description": {
    "en": "Empire bundle with some goods"
  },
  "attributes": [],
  "is_free": false,
  "groups": [
    { … }
  ],
  "prices": [],
  "virtual_prices": [
    { … }
  ],
  "media_list": [],
  "order": 1,
  "is_enabled": true,
  "is_show_in_store": true,
  "regions": [],
  "bundle_type": "standard",
  "content": [
    { … },
    { … },
    { … }
  ],
  "limits": {
    "per_user": { … },
    "per_item": null,
    "recurrent_schedule": null
  },
  "periods": [
    { … }
  ],
  "custom_attributes": {
    "type": "lootbox",
    "purchased": 0
  }
}