GetItemDetails
Yields
This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.
This function returns the item details for the given item. It accepts two parameters - the first indicating the ID of the item being retrieved and the second indicating its Enum/ItemType.
Data returned in the format:
{
"isForRent": true,
"expectedSellerId": 0,
"owned": true,
"isPurchasable": true,
"id": 0,
"itemType": "Asset",
"assetType": "Image",
"bundleType": "BodyParts",
"name": "string",
"description": "string",
"productId": 0,
"genres": [
"All"
],
"bundledItems": [
{
"owned": true,
"id": 0,
"name": "string",
"type": "string"
}
],
"itemStatus": [
"New"
],
"itemRestrictions": [
"ThirteenPlus"
],
"creatorType": "User",
"creatorTargetId": 0,
"creatorName": "string",
"price": 0,
"premiumPricing": {
"premiumDiscountPercentage": 0,
"premiumPriceInRobux": 0
},
"lowestPrice": 0,
"priceStatus": "string",
"unitsAvailableForConsumption": 0,
"purchaseCount": 0,
"favoriteCount": 0
}
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
|
|
The ID of the item whose details are being retrieved |
||
|
|
An enum value indicating the type of item whose details are being retrieved |
Returns
| Return Type | Summary |
|---|---|
|
A table containing the item info for the retrieved item. See above for a sample table |