PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

SearchCatalog

This function returns a CatalogPages object containing the result of the given search.

The returned data has the format:

[
    {
      "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

An object containing the parameters used for the search

Returns

Return Type Summary

A page object containing the result of the given search. See the code sample above for an example.