Inventory - Get Inventory Items

  • Reference
Service:
Economy
API Version:
240412

Get current inventory items.

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

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. Maximum page size is 50. The default value is 10
CollectionId

string

The id of the entity's collection to perform this action on. (Default="default")
ContinuationToken

string

An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on initial request.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity

EntityKey

The entity to perform this action on.
Filter

string

OData Filter to refine the items returned. InventoryItem properties 'type', 'id', and 'stackId' can be used in the filter. For example: "type eq 'currency'"

Responses

Name Type Description
200 OK

GetInventoryItemsResponse

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.
GetInventoryItemsRequest

Given an entity type, entity identifier and container details, will get the entity's inventory items.
GetInventoryItemsResponse
InventoryItem

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

GetInventoryItemsRequest

Given an entity type, entity identifier and container details, will get the entity's inventory items.

Name Type Description
CollectionId

string

The id of the entity's collection to perform this action on. (Default="default")
ContinuationToken

string

An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on initial request.
Count

number

Number of items to retrieve. This value is optional. Maximum page size is 50. 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 to perform this action on.
Filter

string

OData Filter to refine the items returned. InventoryItem properties 'type', 'id', and 'stackId' can be used in the filter. For example: "type eq 'currency'"

GetInventoryItemsResponse

Name Type Description
ContinuationToken

string

An opaque token used to retrieve the next page of items, if any are available.
ETag

string

ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
Items

InventoryItem[]

The requested inventory items.

InventoryItem

Name Type Description
Amount

number

The amount of the item.
DisplayProperties

object

Game specific properties for display purposes. This is an arbitrary JSON blob. The Display Properties field has a 1000 byte limit.
ExpirationDate

string

Only used for subscriptions. The date of when the item will expire in UTC.
Id

string

The id of the item. This should correspond to the item id in the catalog.
StackId

string

The stack id of the item.
Type

string

The type of the item. This should correspond to the item type in the catalog.

Error Codes

Name Code
AccountDeleted 1322
DatabaseThroughputExceeded 1113