Skip to content

Update MarketplaceService.yaml #1035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 28, 2025
Merged

Update MarketplaceService.yaml #1035

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c9f004f
Update MarketplaceService.yaml
sammygrey Feb 25, 2025
00cca89
Apply suggestions from code review
IgnisRBX Feb 26, 2025
52a63b0
Merge branch 'main' into patch-12
IgnisRBX Feb 26, 2025
8aa2b25
Update content/en-us/reference/engine/classes/MarketplaceService.yaml
sammygrey Feb 26, 2025
9c4eb53
Merge branch 'main' into patch-12
sammygrey Feb 26, 2025
1852163
Update MarketplaceService.yaml
sammygrey Feb 27, 2025
e9b225e
Merge branch 'main' into patch-12
sammygrey Feb 27, 2025
4beca4b
Update MarketplaceService.yaml
IgnisRBX Feb 27, 2025
5d99ba1
Merge branch 'main' into patch-12
IgnisRBX Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 105 additions & 38 deletions content/en-us/reference/engine/classes/MarketplaceService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,16 @@ methods:
<td>number</td>
<td>The cost of purchasing the asset using Robux.</td>
</tr>
<tr>
<td><code>ProductId</code></td>
<td>number</td>
<td>The product ID if <code>Enum.InfoType</code> is <code>Product</code>.</td>
</tr>
<tr>
<td><code>ProductType</code></td>
<td>string</td>
<td>A string describing what the product is. Not to be confused with <code>Enum.MarketplaceProductType</code>.</td>
</tr>
<tr>
<td><code>Created</code></td>
<td>string</td>
Expand All @@ -393,10 +403,15 @@ methods:
<td>boolean</td>
<td>Describes whether the asset can be taken for free.</td>
</tr>
<tr>
<td><code>TargetId</code></td>
<td>number</td>
<td>The ID of the product or asset.</td>
</tr>
</tbody>
</table>

#### Creator Information
##### Creator Information

<table size="small">
<thead>
Expand All @@ -410,37 +425,32 @@ methods:
<tr>
<td><code>Creator</code></td>
<td>table</td>
<td>Dictionary table of information describing the creator of the asset (see following lines).</td>
<td>Dictionary table of information describing the creator of the asset, containing the following fields:</td>
</tr>
<tr>
<td><code>Creator.CreatorType</code></td>
<td>string</td>
<td>Either <code>User</code> or <code>Group</code>.</td>
<tr>
<td colspan="2"></td>
<td><code>CreatorType</code>: Either <code>User</code> or <code>Group</code>.</td>
</tr>
<tr>
<td><code>Creator.CreatorTargetId</code></td>
<td>number</td>
<td>The ID of the creator user or group.</td>
<tr>
<td colspan="2"></td>
<td><code>CreatorTargetId</code>: The ID of the creator user or group.</td>
</tr>
<tr>
<td><code>Creator.HasVerifiedBadge</code></td>
<td>boolean</td>
<td>Whether the creator has a verified badge.</td>
<td colspan="2"></td>
<td><code>HasVerifiedBadge</code>: Boolean of whether the creator has a verified badge.</td>
</tr>
<tr>
<td><code>Creator.Name</code></td>
<td>string</td>
<td>The name/username of the creator.</td>
<tr>
<td colspan="2"></td>
<td><code>Name</code>: The name/username of the creator.</td>
</tr>
<tr>
<td><code>Creator.Id</code></td>
<td>number</td>
<td>Use <b>Creator.CreatorTargetId</b> instead.</td>
<tr>
<td colspan="2"></td>
<td><code>Id</code>: Use <code>CreatorTargetId</code> instead.</td>
</tr>
</tbody>
</table>

#### Asset Information
##### Asset Information

<table size="small">
<thead>
Expand All @@ -454,13 +464,18 @@ methods:
<tr>
<td><code>AssetId</code></td>
<td>number</td>
<td>The asset ID if <code>Enum.InfoType</code> is <b>Asset</b>.</td>
<td>The asset ID if <code>Enum.InfoType</code> is <code>Asset</code>.</td>
</tr>
<tr>
<td><code>AssetTypeId</code></td>
<td>number</td>
<td>The type of asset. See <code>Enum.AssetType</code> for the asset type ID numbers.</td>
</tr>
<tr>
<td><code>IconImageAssetId</code></td>
<td>number</td>
<td>The asset ID of the product's icon, or <code>0</code> if there isn't one.</td>
</tr>
<tr>
<td><code>IsForSale</code></td>
<td>boolean</td>
Expand All @@ -484,27 +499,70 @@ methods:
<tr>
<td><code>Remaining</code></td>
<td>number</td>
<td>The remaining number of items a limited unique item may be sold.</td>
<td>The remaining number of times a limited unique item may be sold.</td>
</tr>
<tr>
<td><code>Sales</code></td>
<td>number</td>
<td>The number of items the asset has been sold.</td>
<td>The number of times the asset has been sold.</td>
</tr>
</tbody>
</table>

#### Collectibles Information

<table size="small">
<thead>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>CollectibleItemId</code></td>
<td>string</td>
<td>The unique item ID of the collectible.</td>
</tr>
<tr>
<td><code>CollectibleProductId</code></td>
<td>string</td>
<td>The unique product ID of the collectible.</td>
</tr>
<tr>
<td><code>SaleAvailabilityLocations</code></td>
<td><code>CollectiblesItemDetails</code></td>
<td>table</td>
<td>The item's <code>Enum.ProductLocationRestriction|ProductLocationRestriction</code> or sale location setting.</td>
<td>Dictionary table of information describing the collectible, containing the following fields:</td>
</tr>
<tr>
<td><code>CanBeSoldInThisGame</code></td>
<td>boolean</td>
<td>Describes whether the asset is purchasable in the current experience.</td>
<td colspan="2"></td>
<td><code>CollectibleLowestAvailableResaleItemInstanceId</code>: The unique item instance ID of the lowest available resale for the collectible.</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>CollectibleLowestAvailableResaleProductId</code>: The unique product ID of the lowest available resale for the collectible.</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>CollectibleLowestResalePrice</code>: The lowest resale price for the collectible in Robux.</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>IsForSale</code>: Boolean of whether the collectible is available for sale (not resale).</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>IsLimited</code>: Boolean of whether or not the collectible is limited.</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>TotalQuantity</code>: The total quantity of the collectible available for purchase (not resale).</td>
</tr>
</tbody>
</table>

#### Developer Products and Passes
##### Sale Location Settings

<table size="small">
<thead>
Expand All @@ -516,15 +574,24 @@ methods:
</thead>
<tbody>
<tr>
<td><code>ProductId</code></td>
<td>number</td>
<td>The product ID if <code>Enum.InfoType</code> is <b>Product</b>.</td>
<td><code>CanBeSoldInThisGame</code></td>
<td>boolean</td>
<td>Describes whether the asset is purchasable in the current experience.</td>
</tr>
<tr>
<td><code>IconImageAssetId</code></td>
<td>number</td>
<td>The asset ID of the product/pass icon, or <code>0</code> if there isn't one.</td>
<tr>
<td><code>SaleLocation</code></td>
<td>table</td>
<td>Dictionary table of information describing where the item can be sold, containing the following fields:</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>SaleLocationType</code>: The type of sale location setting. See <code>Enum.ProductLocationRestriction</code> for the sale location setting ID numbers.</td>
</tr>
<tr>
<td colspan="2"></td>
<td><code>UniverseIds</code>: Array table of universes in which the item can be sold (not currently implemented).</td>
</tr>
</tbody>
</table>
code_samples:
- MarketplaceService-GetProductInfo1
Expand Down