Inventory - Delete Inventory Collection

Service:

Economy

API Version:

241122

Delete an Inventory Collection. More information about Inventory Collections can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections

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

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 inventory collection id the request applies to.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
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
Entity	EntityKey	The entity the request is about. Set to the caller by default.

Responses

Name	Type	Description
200 OK	DeleteInventoryCollectionResponse
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
DeleteInventoryCollectionRequest	Delete an Inventory Collection by the specified Id for an Entity
DeleteInventoryCollectionResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.

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

DeleteInventoryCollectionRequest

Delete an Inventory Collection by the specified Id for an Entity

Name	Type	Description
CollectionId	string	The inventory collection id the request applies to.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
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
Entity	EntityKey	The entity the request is about. Set to the caller by default.

DeleteInventoryCollectionResponse

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