Gets a sellable items list from the specified group for building a catalog.
project_id required | integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 59080 |
external_id required | string Default: "armour" Group external ID. |
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. Shows regional prices and restrictions for a catalog if those were specified while creating an item. Note
If you do not specify the country explicitly, it will be set based on user's IP address. 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 sellable items from the specified group was successfully received.
The group wasn’t found. Make sure that the external_id
is correct and the group isn’t turned off or deleted.
{- "has_more": true,
- "items": [
- {
- "item_id": 259774,
- "sku": "electric_shields",
- "type": "virtual_good",
- "name": "Electric shield",
- "description": "Electric shield",
- "price": {
- "amount": "9.99",
- "amount_without_discount": "9.99",
- "currency": "USD"
}, - "virtual_prices": [
- {
- "description": null,
- "item_id": 259765,
- "sku": "gold",
- "name": "Gold",
- "type": "virtual_currency",
- "amount": 10,
- "amount_without_discount": 10,
- "calculated_price": {
- "amount": "10.00",
- "amount_without_discount": "10.00"
}, - "is_default": true
}, - {
- "description": null,
- "item_id": 259766,
- "sku": "silver",
- "name": "Silver",
- "type": "virtual_currency",
- "amount": 20,
- "amount_without_discount": 20,
- "calculated_price": {
- "amount": "20.00",
- "amount_without_discount": "20.00"
}, - "is_default": false
}, - {
- "description": null,
- "item_id": 259767,
- "sku": "bronze",
- "name": "Bronze",
- "type": "virtual_currency",
- "amount": 200,
- "amount_without_discount": 200,
- "calculated_price": {
- "amount": "200.00",
- "amount_without_discount": "200.00"
}, - "is_default": false
}
], - "can_be_bought": true,
- "promotions": [
- {
- "name": "Bonus promotion",
- "date_start": "2020-04-15T16:16:00+03:00",
- "date_end": "2026-04-15T16:16:00+03:00",
- "discount": {
- "percent": "50.00"
}, - "bonus": [
- {
- "quantity": 1,
- "name": "Xsolla Minigun",
- "sku": "minigun_1",
- "type": "virtual_good"
}
]
}
], - "attributes": [ ],
- "is_free": false,
- "groups": [
- {
- "external_id": "armour",
- "name": "Armour"
}
], - "virtual_item_type": "non_consumable",
- "inventory_options": {
- "consumable": null,
- "expiration_period": [
- {
- "item_id": 259775,
- "sku": "royal_shield",
- "type": "virtual_good",
- "name": "Royal shield",
- "description": "Royal shield",
- "price": {
- "amount": "19.99",
- "amount_without_discount": "19.99",
- "currency": "USD"
}, - "virtual_prices": [
- {
- "description": null,
- "item_id": 259765,
- "sku": "gold",
- "name": "Gold",
- "type": "virtual_currency",
- "amount": 20,
- "amount_without_discount": 20,
- "calculated_price": {
- "amount": "20.00",
- "amount_without_discount": "20.00"
}, - "is_default": true
}, - {
- "description": null,
- "item_id": 259766,
- "sku": "silver",
- "name": "Silver",
- "type": "virtual_currency",
- "amount": 40,
- "amount_without_discount": 40,
- "calculated_price": {
- "amount": "40.00",
- "amount_without_discount": "40.00"
}, - "is_default": false
}, - {
- "description": null,
- "item_id": 259767,
- "sku": "bronze",
- "name": "Bronze",
- "type": "virtual_currency",
- "amount": 400,
- "amount_without_discount": 400,
- "calculated_price": {
- "amount": "400.00",
- "amount_without_discount": "400.00"
}, - "is_default": false
}
], - "can_be_bought": true,
- "promotions": [ ],
- "attributes": [ ],
- "is_free": false,
- "groups": [
- {
- "external_id": "armour",
- "name": "Armour"
}
], - "virtual_item_type": "non_consumable",
- "inventory_options": {
- "consumable": null,
- "expiration_period": null
}
}, - {
- "item_id": 259776,
- "sku": "ancient_helmet",
- "type": "virtual_good",
- "name": "Ancient helmet",
- "description": "Ancient helmet",
- "price": {
- "amount": "1.99",
- "amount_without_discount": "1.99",
- "currency": "USD"
}, - "virtual_prices": [
- {
- "description": null,
- "item_id": 259765,
- "sku": "gold",
- "name": "Gold",
- "type": "virtual_currency",
- "amount": 2,
- "amount_without_discount": 2,
- "calculated_price": {
- "amount": "2.00",
- "amount_without_discount": "2.00"
}, - "is_default": true
}, - {
- "description": null,
- "item_id": 259766,
- "sku": "silver",
- "name": "Silver",
- "type": "virtual_currency",
- "amount": 4,
- "amount_without_discount": 4,
- "calculated_price": {
- "amount": "4.00",
- "amount_without_discount": "4.00"
}, - "is_default": false
}, - {
- "description": null,
- "item_id": 259767,
- "sku": "bronze",
- "name": "Bronze",
- "type": "virtual_currency",
- "amount": 40,
- "amount_without_discount": 40,
- "calculated_price": {
- "amount": "40.00",
- "amount_without_discount": "40.00"
}, - "is_default": false
}
], - "can_be_bought": true,
- "promotions": [
- {
- "name": "Bonus promotion",
- "date_start": "2020-04-15T16:16:00+03:00",
- "date_end": "2026-04-15T16:16:00+03:00",
- "discount": {
- "percent": "50.00"
}, - "bonus": [
- {
- "quantity": 1,
- "name": "Xsolla Minigun",
- "sku": "minigun_1",
- "type": "virtual_good"
}
]
}
], - "attributes": [ ],
- "is_free": false,
- "groups": [
- {
- "external_id": "armour",
- "name": "Armour"
}
], - "virtual_item_type": "non_consumable",
- "inventory_options": {
- "consumable": null,
- "expiration_period": null
}
}, - {
- "item_id": 259777,
- "sku": "wooden_helmet",
- "type": "virtual_good",
- "name": "Wooden helmet",
- "description": "Wooden helmet",
- "price": {
- "amount": "0.99",
- "amount_without_discount": "0.99",
- "currency": "USD"
}, - "virtual_prices": [
- {
- "description": null,
- "item_id": 259765,
- "sku": "gold",
- "name": "Gold",
- "type": "virtual_currency",
- "amount": 1,
- "amount_without_discount": 1,
- "calculated_price": {
- "amount": "1.00",
- "amount_without_discount": "1.00"
}, - "is_default": true
}, - {
- "description": null,
- "item_id": 259766,
- "sku": "silver",
- "name": "Silver",
- "type": "virtual_currency",
- "amount": 2,
- "amount_without_discount": 2,
- "calculated_price": {
- "amount": "2.00",
- "amount_without_discount": "2.00"
}, - "is_default": false
}, - {
- "description": null,
- "item_id": 259767,
- "sku": "bronze",
- "name": "Bronze",
- "type": "virtual_currency",
- "amount": 20,
- "amount_without_discount": 20,
- "calculated_price": {
- "amount": "20.00",
- "amount_without_discount": "20.00"
}, - "is_default": false
}
], - "can_be_bought": true,
- "promotions": [
- {
- "name": "Bonus promotion",
- "date_start": "2020-04-15T16:16:00+03:00",
- "date_end": "2026-04-15T16:16:00+03:00",
- "discount": {
- "percent": "50.00"
}, - "bonus": [
- {
- "quantity": 1,
- "name": "Xsolla Minigun",
- "sku": "minigun_1",
- "type": "virtual_good"
}
]
}
], - "attributes": [ ],
- "is_free": false,
- "groups": [
- {
- "external_id": "armour",
- "name": "Armour"
}
], - "virtual_item_type": "non_consumable",
- "inventory_options": {
- "consumable": null,
- "expiration_period": null
}
}
]
}, - "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
}
], - "custom_attributes": {
- "purchased": 0,
- "attr": "value"
}
}
]
}