Get list of bundles by specified group external id

Xsolla Developers

To Publisher Account

Get list of bundles by specified group external idServer-sideAdmin

get/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}

Gets the list of bundles within a group for administration.

Note

Do not use this endpoint for building a store catalog.

SecuritybasicAuth

Request

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
promo_code	string [ 1 .. 128 ] characters Unique case sensitive code. Contains letters and numbers. Example: promo_code=WINTER2021

Responses

200

The list of bundles was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

curl -i -X GET \
  -u <merchant_id_or_project_id>:<api_key> \
  'https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}?limit=50&offset=0&promo_code=WINTER2021'

Response samples

application/json

{"items": [{"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {"en": "Ultra Super lootbox with different items"
},
"attributes": [ ],
"is_free": false,
"groups": [{"external_id": "all",
"name": {"en": "Equipment"
}
}
],
"prices": [{"amount": 150.49,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [ ],
"media_list": [ ],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "standard",
"content": [{"sku": "com.xsolla.booster_min_1",
"name": {"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{"sku": "com.xsolla.booster_min_2",
"name": {"en": "Booster"
},
"type": "virtual_good",
"description": {"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{"sku": "com.xsolla.gloves_1",
"name": {"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{"sku": "com.xsolla.boots_1",
"name": {"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{"sku": "com.xsolla.gun_max",
"name": {"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{"sku": "com.xsolla.minigun_2",
"name": {"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {"per_user": {"total": 10
},
"per_item": {"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {"per_user": {"interval_type": "weekly",
"day_of_week": 2,
"day_of_month": null,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00"
}
}
},
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {"type": "lootbox",
"purchased": 0
}
},
{"item_id": 610317,
"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": [{"external_id": "all",
"name": {"en": "Equipment"
}
}
],
"prices": [ ],
"virtual_prices": [{"sku": "com.xsolla.crystal_1",
"name": {"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": 150,
"is_default": true
}
],
"media_list": [ ],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"bundle_type": "standard",
"content": [{"sku": "com.xsolla.keys_2",
"name": {"en": "Empire Key"
},
"type": "virtual_good",
"description": {"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{"sku": "com.xsolla.booster_mega_2",
"name": {"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{"sku": "com.xsolla.booster_min_2",
"name": {"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [ ]
}
]
}

Get list of bundles by specified group external idServer-sideAdmin

path Parameters

query Parameters

We respect your privacy