Catalog

Catalog Management APIs. In general for Catalog APIs, Read APIs are limited to 100 requests in 60 seconds for Player Entities while Title Entities are limited to 10000 requests in 10 seconds. For Write APIs, Player Entities are limited to 10 requests in 30 seconds and Title Entities are limited to 1000 requests in 10 seconds.

Operations

Create Draft Item

Creates a new item in the working catalog using provided metadata.

Create Upload Urls

Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 ho...

Delete Entity Item Reviews

Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.

Delete Item

Removes an item from working catalog and all published versions from the public catalog.

Get Catalog Config

Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10 seconds for this API. More information abo...

Get Draft Item

Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog an...

Get Draft Items

Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. GetDraftItems does not work off a cache of th...

Get Entity Draft Items

Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at once. You can use continuation tokens to...

Get Entity Item Review

Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update in near real time with delays within a ...

Get Item

Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, ...

Get Item Containers

Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at once. You can use continuation tokens to p...

Get Item Moderation State

Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://lea...

Get Item Publish Status

Gets the status of a publish of an item.

Get Item Reviews

Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few seconds...

Get Item Review Summary

Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update data coming within 15 minutes.

Get Items

Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of the Catalog and should be used when tryin...

Publish Draft Item

Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.

Report Item

Submit a report for an item, indicating in what way the item is inappropriate.

Report Item Review

Submit a report for a review

Review Item

Creates or updates a review for the specified item. More information around the caching surrounding item ratings and reviews can be found here: https://learn.mi...

Search Items

Executes a search against the public catalog using the provided search parameters and returns a set of paginated results. SearchItems uses a cache of the catalo...

Set Item Moderation State

Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://lea...

Submit Item Review Vote

Submit a vote for a review, indicating whether the review was helpful or unhelpful.

Takedown Item Reviews

Submit a request to takedown one or more reviews.

Update Catalog Config

Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information a...

Update Draft Item

Update the metadata for an item in the working catalog.