Get list of virtual items by specified group external id

Get list of virtual items by specified group external idServer-sideAdmin

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

Gets the list of virtual items 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 virtual items was successfully received.

401

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

Request samples

Response samples

application/json

{"items": [{"sku": "armor_max_2",
"name": {"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {"en": "Defend your Empire against Xsolla with the max armor"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": "merchant_virtual_items_virtual_item_long_description_160310",
"attributes": [ ],
"is_free": false,
"order": 1,
"groups": [{"external_id": "hair",
"name": {"en": "Hair"
}
},
{"external_id": "accessory",
"name": {"en": "Accessory"
}
}
],
"prices": [{"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"inventory_options": {"consumable": true,
"expiration_period": null
},
"limits": {"per_user": {"total": 5
},
"per_item": null,
"recurrent_schedule": {"per_user": {"interval_type": "monthly",
"day_of_week": null,
"day_of_month": 28,
"time": "11:00:00+08:00",
"reset_next_date": 1679972400,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-28T11: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": {"purchased": 0,
"attr": "value"
}
},
{"sku": "armor_med_1",
"name": {"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [ ],
"is_free": false,
"order": 1,
"groups": [{"external_id": "hair",
"name": {"en": "Hair"
}
},
{"external_id": "accessory",
"name": {"en": "Accessory"
}
}
],
"prices": [{"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": false,
"regions": [ ],
"inventory_options": {"consumable": true,
"expiration_period": null
},
"limits": {"per_user": {"total": 5
},
"per_item": null,
"recurrent_schedule": {"per_user": {"interval_type": "daily",
"day_of_week": null,
"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-02-28T11:00:00+08:00"
}
}
},
"periods": [{"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{"sku": "armor_med_2",
"name": {"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {"en": "Moderately protect yourself against Xsolla's barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": "merchant_virtual_items_virtual_item_long_description_160311",
"attributes": [{"external_id": "attr_1",
"name": {"en-US": "OK"
},
"values": [{"external_id": "val1",
"value": {"en-US": "VALUE"
}
},
{"external_id": "val2",
"value": {"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [{"external_id": "hair",
"name": {"en": "Hair"
}
},
{"external_id": "accessory",
"name": {"en": "Accessory"
}
}
],
"prices": [{"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"inventory_options": {"consumable": true,
"expiration_period": null
},
"limits": {"per_user": {"total": 5
},
"per_item": {"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {"per_user": {"interval_type": "daily",
"day_of_week": null,
"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-02-28T11:00:00+08:00"
}
}
},
"periods": [ ]
}
]
}