Skip to content

Commit 0655124

Browse files
sammygreyIgnisRBX
sammygrey
and
IgnisRBX
authored
Update MarketplaceService.yaml (#1035)
## Changes Added/removed/moved a ton of things for GetProductInfo(): - Moved product id to product section. - Moved IconImageAssetId to asset section. - Removed gamepass/dev products section (these fields apply to all products and assets not just gamepasses/dev products). - Added seperate table for collectibles information with the appropriate fields. - Moved sale location information to seperate table with more information. - Fixed typos where "times" was instead typed as "items". - Added TargetId to product section which wasn't present for some reason. With all this the page should now be consistent with the result of [MarketplaceService:GetProductInfo()](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetProductInfo): ![image](https://github.com/user-attachments/assets/18b08a71-aa98-4e1c-821a-39a6958cdc29) Credit to [@valkenheim](https://devforum.roblox.com/u/Valkenheim) for a [devforum post](https://devforum.roblox.com/t/collectiblesitemdetails-not-covered-in-documentation/3505808) regarding the inconsistencies on this page, but this page was kind of a mess all around. ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: IgnisRBX <[email protected]>
1 parent 565db3f commit 0655124

File tree

1 file changed

+105
-38
lines changed

1 file changed

+105
-38
lines changed

‎content/en-us/reference/engine/classes/MarketplaceService.yaml‎

Lines changed: 105 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,16 @@ methods:
368368
<td>number</td>
369369
<td>The cost of purchasing the asset using Robux.</td>
370370
</tr>
371+
<tr>
372+
<td><code>ProductId</code></td>
373+
<td>number</td>
374+
<td>The product ID if <code>Enum.InfoType</code> is <code>Product</code>.</td>
375+
</tr>
376+
<tr>
377+
<td><code>ProductType</code></td>
378+
<td>string</td>
379+
<td>A string describing what the product is. Not to be confused with <code>Enum.MarketplaceProductType</code>.</td>
380+
</tr>
371381
<tr>
372382
<td><code>Created</code></td>
373383
<td>string</td>
@@ -393,10 +403,15 @@ methods:
393403
<td>boolean</td>
394404
<td>Describes whether the asset can be taken for free.</td>
395405
</tr>
406+
<tr>
407+
<td><code>TargetId</code></td>
408+
<td>number</td>
409+
<td>The ID of the product or asset.</td>
410+
</tr>
396411
</tbody>
397412
</table>
398413
399-
#### Creator Information
414+
##### Creator Information
400415
401416
<table size="small">
402417
<thead>
@@ -410,37 +425,32 @@ methods:
410425
<tr>
411426
<td><code>Creator</code></td>
412427
<td>table</td>
413-
<td>Dictionary table of information describing the creator of the asset (see following lines).</td>
428+
<td>Dictionary table of information describing the creator of the asset, containing the following fields:</td>
414429
</tr>
415-
<tr>
416-
<td><code>Creator.CreatorType</code></td>
417-
<td>string</td>
418-
<td>Either <code>User</code> or <code>Group</code>.</td>
430+
<tr>
431+
<td colspan="2"></td>
432+
<td><code>CreatorType</code>: Either <code>User</code> or <code>Group</code>.</td>
419433
</tr>
420-
<tr>
421-
<td><code>Creator.CreatorTargetId</code></td>
422-
<td>number</td>
423-
<td>The ID of the creator user or group.</td>
434+
<tr>
435+
<td colspan="2"></td>
436+
<td><code>CreatorTargetId</code>: The ID of the creator user or group.</td>
424437
</tr>
425438
<tr>
426-
<td><code>Creator.HasVerifiedBadge</code></td>
427-
<td>boolean</td>
428-
<td>Whether the creator has a verified badge.</td>
439+
<td colspan="2"></td>
440+
<td><code>HasVerifiedBadge</code>: Boolean of whether the creator has a verified badge.</td>
429441
</tr>
430-
<tr>
431-
<td><code>Creator.Name</code></td>
432-
<td>string</td>
433-
<td>The name/username of the creator.</td>
442+
<tr>
443+
<td colspan="2"></td>
444+
<td><code>Name</code>: The name/username of the creator.</td>
434445
</tr>
435-
<tr>
436-
<td><code>Creator.Id</code></td>
437-
<td>number</td>
438-
<td>Use <b>Creator.CreatorTargetId</b> instead.</td>
446+
<tr>
447+
<td colspan="2"></td>
448+
<td><code>Id</code>: Use <code>CreatorTargetId</code> instead.</td>
439449
</tr>
440450
</tbody>
441451
</table>
442452
443-
#### Asset Information
453+
##### Asset Information
444454
445455
<table size="small">
446456
<thead>
@@ -454,13 +464,18 @@ methods:
454464
<tr>
455465
<td><code>AssetId</code></td>
456466
<td>number</td>
457-
<td>The asset ID if <code>Enum.InfoType</code> is <b>Asset</b>.</td>
467+
<td>The asset ID if <code>Enum.InfoType</code> is <code>Asset</code>.</td>
458468
</tr>
459469
<tr>
460470
<td><code>AssetTypeId</code></td>
461471
<td>number</td>
462472
<td>The type of asset. See <code>Enum.AssetType</code> for the asset type ID numbers.</td>
463473
</tr>
474+
<tr>
475+
<td><code>IconImageAssetId</code></td>
476+
<td>number</td>
477+
<td>The asset ID of the product's icon, or <code>0</code> if there isn't one.</td>
478+
</tr>
464479
<tr>
465480
<td><code>IsForSale</code></td>
466481
<td>boolean</td>
@@ -484,27 +499,70 @@ methods:
484499
<tr>
485500
<td><code>Remaining</code></td>
486501
<td>number</td>
487-
<td>The remaining number of items a limited unique item may be sold.</td>
502+
<td>The remaining number of times a limited unique item may be sold.</td>
488503
</tr>
489504
<tr>
490505
<td><code>Sales</code></td>
491506
<td>number</td>
492-
<td>The number of items the asset has been sold.</td>
507+
<td>The number of times the asset has been sold.</td>
508+
</tr>
509+
</tbody>
510+
</table>
511+
512+
#### Collectibles Information
513+
514+
<table size="small">
515+
<thead>
516+
<tr>
517+
<th>Key</th>
518+
<th>Type</th>
519+
<th>Description</th>
520+
</tr>
521+
</thead>
522+
<tbody>
523+
<tr>
524+
<td><code>CollectibleItemId</code></td>
525+
<td>string</td>
526+
<td>The unique item ID of the collectible.</td>
527+
</tr>
528+
<tr>
529+
<td><code>CollectibleProductId</code></td>
530+
<td>string</td>
531+
<td>The unique product ID of the collectible.</td>
493532
</tr>
494533
<tr>
495-
<td><code>SaleAvailabilityLocations</code></td>
534+
<td><code>CollectiblesItemDetails</code></td>
496535
<td>table</td>
497-
<td>The item's <code>Enum.ProductLocationRestriction|ProductLocationRestriction</code> or sale location setting.</td>
536+
<td>Dictionary table of information describing the collectible, containing the following fields:</td>
498537
</tr>
499538
<tr>
500-
<td><code>CanBeSoldInThisGame</code></td>
501-
<td>boolean</td>
502-
<td>Describes whether the asset is purchasable in the current experience.</td>
539+
<td colspan="2"></td>
540+
<td><code>CollectibleLowestAvailableResaleItemInstanceId</code>: The unique item instance ID of the lowest available resale for the collectible.</td>
541+
</tr>
542+
<tr>
543+
<td colspan="2"></td>
544+
<td><code>CollectibleLowestAvailableResaleProductId</code>: The unique product ID of the lowest available resale for the collectible.</td>
545+
</tr>
546+
<tr>
547+
<td colspan="2"></td>
548+
<td><code>CollectibleLowestResalePrice</code>: The lowest resale price for the collectible in Robux.</td>
549+
</tr>
550+
<tr>
551+
<td colspan="2"></td>
552+
<td><code>IsForSale</code>: Boolean of whether the collectible is available for sale (not resale).</td>
553+
</tr>
554+
<tr>
555+
<td colspan="2"></td>
556+
<td><code>IsLimited</code>: Boolean of whether or not the collectible is limited.</td>
557+
</tr>
558+
<tr>
559+
<td colspan="2"></td>
560+
<td><code>TotalQuantity</code>: The total quantity of the collectible available for purchase (not resale).</td>
503561
</tr>
504562
</tbody>
505563
</table>
506564
507-
#### Developer Products and Passes
565+
##### Sale Location Settings
508566
509567
<table size="small">
510568
<thead>
@@ -516,15 +574,24 @@ methods:
516574
</thead>
517575
<tbody>
518576
<tr>
519-
<td><code>ProductId</code></td>
520-
<td>number</td>
521-
<td>The product ID if <code>Enum.InfoType</code> is <b>Product</b>.</td>
577+
<td><code>CanBeSoldInThisGame</code></td>
578+
<td>boolean</td>
579+
<td>Describes whether the asset is purchasable in the current experience.</td>
522580
</tr>
523-
<tr>
524-
<td><code>IconImageAssetId</code></td>
525-
<td>number</td>
526-
<td>The asset ID of the product/pass icon, or <code>0</code> if there isn't one.</td>
581+
<tr>
582+
<td><code>SaleLocation</code></td>
583+
<td>table</td>
584+
<td>Dictionary table of information describing where the item can be sold, containing the following fields:</td>
527585
</tr>
586+
<tr>
587+
<td colspan="2"></td>
588+
<td><code>SaleLocationType</code>: The type of sale location setting. See <code>Enum.ProductLocationRestriction</code> for the sale location setting ID numbers.</td>
589+
</tr>
590+
<tr>
591+
<td colspan="2"></td>
592+
<td><code>UniverseIds</code>: Array table of universes in which the item can be sold (not currently implemented).</td>
593+
</tr>
594+
</tbody>
528595
</table>
529596
code_samples:
530597
- MarketplaceService-GetProductInfo1

0 commit comments

Comments
 (0)