Inventory - Get Inventory Collection Ids

Service:

Economy

API Version:

240426

Get Inventory Collection Ids. Up to 50 Ids can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for new collection Ids to show up.

POST https://titleId.playfabapi.com/Inventory/GetInventoryCollectionIds

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Count	True	number	Number of items to retrieve. This value is optional. The default value is 10
ContinuationToken		string	An opaque token used to retrieve the next page of collection ids, if any are available.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity		EntityKey	The entity the request is about. Set to the caller by default.

Responses

Name	Type	Description
200 OK	GetInventoryCollectionIdsResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
GetInventoryCollectionIdsRequest	Get a list of Inventory Collection Ids for the specified Entity
GetInventoryCollectionIdsResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

GetInventoryCollectionIdsRequest

Get a list of Inventory Collection Ids for the specified Entity

Name	Type	Description
ContinuationToken	string	An opaque token used to retrieve the next page of collection ids, if any are available.
Count	number	Number of items to retrieve. This value is optional. The default value is 10
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity the request is about. Set to the caller by default.

GetInventoryCollectionIdsResponse

Name	Type	Description
CollectionIds	string[]	The requested inventory collection ids.
ContinuationToken	string	An opaque token used to retrieve the next page of collection ids, if any are available.