Skip to content

Commit c9f004f

Browse files
authored
Update MarketplaceService.yaml
Added/removed/moved a ton of things: moved product id to product section moved IconImageAssetId to asset section removed gamepass/dev products section (these items 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
1 parent cb7a39c commit c9f004f

File tree

1 file changed

+93
-13
lines changed

1 file changed

+93
-13
lines changed

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

Lines changed: 93 additions & 13 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 <b>Product</b>.</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,6 +403,11 @@ 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
@@ -461,6 +476,11 @@ methods:
461476
<td>number</td>
462477
<td>The type of asset. See <code>Enum.AssetType</code> for the asset type ID numbers.</td>
463478
</tr>
479+
<tr>
480+
<td><code>IconImageAssetId</code></td>
481+
<td>number</td>
482+
<td>The asset ID of the product's icon, or <code>0</code> if there isn't one.</td>
483+
</tr>
464484
<tr>
465485
<td><code>IsForSale</code></td>
466486
<td>boolean</td>
@@ -484,27 +504,76 @@ methods:
484504
<tr>
485505
<td><code>Remaining</code></td>
486506
<td>number</td>
487-
<td>The remaining number of items a limited unique item may be sold.</td>
507+
<td>The remaining number of times a limited unique item may be sold.</td>
488508
</tr>
489509
<tr>
490510
<td><code>Sales</code></td>
491511
<td>number</td>
492-
<td>The number of items the asset has been sold.</td>
512+
<td>The number of times the asset has been sold.</td>
513+
</tr>
514+
</tbody>
515+
</table>
516+
517+
#### Collectibles Information
518+
519+
<table size="small">
520+
<thead>
521+
<tr>
522+
<th>Key</th>
523+
<th>Type</th>
524+
<th>Description</th>
525+
</tr>
526+
</thead>
527+
<tbody>
528+
<tr>
529+
<td><code>CollectibleItemId</code></td>
530+
<td>string</td>
531+
<td>The unique item ID of the collectible.</code>.</td>
532+
</tr>
533+
<tr>
534+
<td><code>CollectibleProductId</code></td>
535+
<td>string</td>
536+
<td>The unique product ID of the collectible.</td>
493537
</tr>
494538
<tr>
495-
<td><code>SaleAvailabilityLocations</code></td>
539+
<td><code>CollectiblesItemDetails</code></td>
496540
<td>table</td>
497-
<td>The item's <code>Enum.ProductLocationRestriction|ProductLocationRestriction</code> or sale location setting.</td>
541+
<td>Dictionary table of information describing the collectible (see following lines).</td>
542+
</tr>
543+
<tr>
544+
<td><code>CollectibleLowestAvailableResaleItemInstanceId</code></td>
545+
<td>string</td>
546+
<td>The unique item instance ID of the lowest available resale for the collectible.</td>
547+
</tr>
548+
<tr>
549+
<td><code>CollectibleLowestAvailableResaleProductId</code></td>
550+
<td>string</td>
551+
<td><The unique product ID of the lowest available resale for the collectible./td>
498552
</tr>
499553
<tr>
500-
<td><code>CanBeSoldInThisGame</code></td>
554+
<td><code>CollectibleLowestResalePrice</code></td>
555+
<td>number</td>
556+
<td>The lowest resale price for the collectible in Robux.</td>
557+
</tr>
558+
<tr>
559+
<td><code>IsForSale</code></td>
501560
<td>boolean</td>
502-
<td>Describes whether the asset is purchasable in the current experience.</td>
561+
<td>If the collectible is available for sale (not resale).</td>
562+
</tr>
563+
<tr>
564+
<td><code>IsLimited</code></td>
565+
<td>boolean</td>
566+
<td>Whether or not the collectible is limited.</td>
567+
</tr>
568+
<tr>
569+
<td><code>TotalQuantity</code></td>
570+
<td>number</td>
571+
<td>The total quantity of the collectible available for purchase (not resale).</td>
503572
</tr>
504573
</tbody>
505574
</table>
506575
507-
#### Developer Products and Passes
576+
#### Sale Location Settings
508577
509578
<table size="small">
510579
<thead>
@@ -516,15 +585,26 @@ methods:
516585
</thead>
517586
<tbody>
518587
<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>
588+
<td><code>CanBeSoldInThisGame</code></td>
589+
<td>boolean</td>
590+
<td>Describes whether the asset is purchasable in the current experience.</td>
522591
</tr>
523-
<tr>
524-
<td><code>IconImageAssetId</code></td>
592+
<tr>
593+
<td><code>SaleLocation</code></td>
594+
<td>table</td>
595+
<td>Dictionary table of information describing where the item can be sold (see following lines).</td>
596+
</tr>
597+
<tr>
598+
<td><code>SaleLocationType</code></td>
525599
<td>number</td>
526-
<td>The asset ID of the product/pass icon, or <code>0</code> if there isn't one.</td>
600+
<td>The type of sale location setting. See <code>Enum.ProductLocationRestriction</code> for the sale location setting ID numbers</td>
527601
</tr>
602+
<tr>
603+
<td><code>UniverseIds</code></td>
604+
<td>table</td>
605+
<td>Array table of universes in which the item can be sold (not currently implemented).</td>
606+
</tr>
607+
</tbody>
528608
</table>
529609
code_samples:
530610
- MarketplaceService-GetProductInfo1

0 commit comments

Comments
 (0)