diff --git a/content/en-us/reference/engine/classes/MarketplaceService.yaml b/content/en-us/reference/engine/classes/MarketplaceService.yaml index ce83c3ede..4d0850aa8 100644 --- a/content/en-us/reference/engine/classes/MarketplaceService.yaml +++ b/content/en-us/reference/engine/classes/MarketplaceService.yaml @@ -59,6 +59,294 @@ methods: security: None thread_safety: Unsafe capabilities: [] + - name: MarketplaceService:GetProductInfoAsync + summary: | + Returns the product information of an asset using its asset ID. + description: | + This method provides information about an asset, + [developer product](../../../production/monetization/developer-products.md), + or [pass](../../../production/monetization/game-passes.md) based on the + asset ID and the `Enum.InfoType`. If an item with the given ID does not + exist, this method throws an error. + + Information about the queried item is provided in a dictionary with the + following keys. Note that not all information is provided or necessarily + relevant for the kind of product you're querying. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyTypeDescription
NamestringThe name shown on the asset's page.
DescriptionstringThe description shown on the asset's page; can be nil if blank.
PriceInRobuxnumberThe cost of purchasing the asset using Robux.
ProductIdnumberThe product ID if Enum.InfoType is Product.
ProductTypestringA string describing what the product is. Not to be confused with Enum.MarketplaceProductType.
CreatedstringTimestamp of when the asset was created, for example 2022-01-02T10:30:45Z. Formatted using ISO 8601.
UpdatedstringTimestamp of when the asset was last updated by its creator, for example 2022-02-12T11:22:15Z. Formatted using ISO 8601.
ContentRatingTypeIdnumberIndicates whether the item is marked as 13+ in catalog.
MinimumMembershipLevelnumberThe minimum subscription level necessary to purchase the item.
IsPublicDomainbooleanDescribes whether the asset can be taken for free.
TargetIdnumberThe ID of the product or asset.
+ + ##### Creator Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyTypeDescription
CreatortableDictionary table of information describing the creator of the asset, containing the following fields:
CreatorType: Either User or Group.
CreatorTargetId: The ID of the creator user or group.
HasVerifiedBadge: Boolean of whether the creator has a verified badge.
Name: The name/username of the creator.
Id: Use CreatorTargetId instead.
+ + ##### Asset Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyTypeDescription
AssetIdnumberThe asset ID if Enum.InfoType is Asset.
AssetTypeIdnumberThe type of asset. See Enum.AssetType for the asset type ID numbers.
IconImageAssetIdnumberThe asset ID of the product's icon, or 0 if there isn't one.
IsForSalebooleanDescribes whether the asset is purchasable.
IsLimitedbooleanDescribes whether the asset is a Roblox Limited that is no longer (if ever) sold.
IsLimitedUniquebooleanDescribes whether the asset is a unique Roblox Limited ("Limited U") item that only has a fixed number sold.
IsNewbooleanDescribes whether the asset is marked as "new" in the catalog.
RemainingnumberThe remaining number of times a limited unique item may be sold.
SalesnumberThe number of times the asset has been sold.
+ + ##### Collectibles Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyTypeDescription
CollectibleItemIdstringThe unique item ID of the collectible.
CollectibleProductIdstringThe unique product ID of the collectible.
CollectiblesItemDetailstableDictionary table of information describing the collectible, containing the following fields:
CollectibleLowestAvailableResaleItemInstanceId: The unique item instance ID of the lowest available resale for the collectible.
CollectibleLowestAvailableResaleProductId: The unique product ID of the lowest available resale for the collectible.
CollectibleLowestResalePrice: The lowest resale price for the collectible in Robux.
IsForSale: Boolean of whether the collectible is available for sale (not resale).
IsLimited: Boolean of whether or not the collectible is limited.
TotalQuantity: The total quantity of the collectible available for purchase (not resale).
+ + ##### Sale Location Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyTypeDescription
CanBeSoldInThisGamebooleanDescribes whether the asset is purchasable in the current experience.
SaleLocationtableDictionary table of information describing where the item can be sold, containing the following fields:
SaleLocationType: The type of sale location setting. See Enum.ProductLocationRestriction for the sale location setting ID numbers.
UniverseIds: Array table of universes in which the item can be sold (not currently implemented).
+ code_samples: + - MarketplaceService-GetProductInfo1 + parameters: + - name: assetId + type: int64 + default: + summary: | + The asset ID of the specified product. + - name: infoType + type: InfoType + default: Asset + summary: | + An `Enum.InfoType` enum value specifying the type of information being + retrieved. + returns: + - type: Dictionary + summary: | + A dictionary containing information about the queried item, described + in the previous tables. + tags: + - Yields + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: [] - name: MarketplaceService:GetProductInfo summary: | Returns the product information of an asset using its asset ID.