Get list of bundles by specified groupClient-side
Gets a list of bundles within a group for building a catalog.
All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response.
In general, the use of catalog of items is available without authorization.
Only authorized users can get a personalized catalog.
path Parameters
| project_id required | integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056 |
| external_id required | string Default: "all" Group external ID. |
query Parameters
| limit | integer Limit for the number of elements on the page. Example: limit=50 |
| offset | integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0 |
| locale | string Default: "en" Response language. Two-letter lowercase language code per ISO 639-1. |
| additional_fields[] | Array of strings The list of additional fields. These fields will be in the response if you send them in your request. |
| country | string Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla and the process of determining the country. Example: country=US |
| promo_code | string [ 1 .. 128 ] characters Unique case sensitive code. Contains letters and numbers. Example: promo_code=WINTER2021 |
| show_inactive_time_limited_items | integer Default: 0 Shows time-limited items that are not available to the user. The validity period of such items has not started or has already expired. Example: show_inactive_time_limited_items=1 |
The list of bundles was successfully received.
- curl
- JavaScript
- Node.js
- Python
- C#
- Go
- Java
- 200
{- "has_more": true,
- "items": [
- {
- "item_id": 61031,
- "sku": "kg_1",
- "name": "kg_10.00_bundle",
- "type": "bundle",
- "description": "pricePoint_44056_1",
- "image_url": null,
- "long_description": null,
- "attributes": {
- "external_id": "genre",
- "name": "Genre",
- "values": [
- {
- "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
- "value": "Casual"
}, - {
- "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
- "value": "Strategy"
}, - {
- "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
- "value": "Mobile"
}
]
}, - "is_free": false,
- "order": 999,
- "groups": [ ],
- "price": {
- "amount": 9.99,
- "currency": "USD",
- "amount_without_discount": 9.99
}, - "total_content_price": {
- "amount": 10.99,
- "currency": "USD",
- "amount_without_discount": 10.99
}, - "media_list": [ ],
- "virtual_prices": [ ],
- "can_be_bought": true,
- "bundle_type": "standard",
- "promotions": [ ],
- "limits": {
- "per_user": {
- "total": 5,
- "available": 3,
- "recurrent_schedule": {
- "interval_type": "weekly",
- "reset_next_date": 1746057600
}
}
}, - "periods": [
- {
- "date_from": "2020-08-11T10:00:00+03:00",
- "date_until": "2020-08-11T20:00:00+03:00"
}
], - "custom_attributes": {
- "purchased": 0,
- "attr": "value"
}, - "content": [
- {
- "sku": "big_rocket",
- "name": "Big Rocket",
- "description": "Big Rocket - short description.",
- "type": "virtual_currency",
- "quantity": 100,
- "virtual_item_type": "non_consumable",
- "attributes": {
- "external_id": "size",
- "name": "Size",
- "values": [
- {
- "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
- "value": "Large"
}
]
}, - "is_free": false,
- "groups": [ ],
- "price": {
- "amount": 10.99,
- "currency": "USD",
- "amount_without_discount": 10.99
}, - "virtual_prices": [ ],
- "limits": {
- "per_user": {
- "total": 5,
- "available": 3,
- "recurrent_schedule": {
- "interval_type": "weekly",
- "reset_next_date": 1746057600
}
}
}
}
], - "vp_rewards": [
- {
- "item_id": 175232,
- "sku": "value_point_1",
- "amount": 130,
- "name": "Value point",
}, - {
- "item_id": 186321,
- "sku": "clan_value_point_sku_1",
- "amount": 50,
- "name": "Clan Reward VP 1",
- "is_clan": true
}
]
}
]
}
