Inventory - Get Inventory Operation Status

Service:

Economy

API Version:

241122

Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the this API.

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

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	Type	Description
CollectionId	string	The id of the entity's collection to perform this action on. (Default="default")
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.

Responses

Name	Type	Description
200 OK	GetInventoryOperationStatusResponse
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.
GetInventoryOperationStatusRequest	Get the status of an Inventory Operation using an OperationToken.
GetInventoryOperationStatusResponse

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

GetInventoryOperationStatusRequest

Get the status of an Inventory Operation using an OperationToken.

Name	Type	Description
CollectionId	string	The id of the entity's collection to perform this action on. (Default="default")
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.

GetInventoryOperationStatusResponse

Name	Type	Description
OperationStatus	string	The inventory operation status.