Subtract Inventory Items
Subtract inventory items.
Allowed entity token types: title, master_player_account, title_player_account
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| DatabaseThroughputExceeded | 1113 |
| InsufficientFunds | 1059 |
| ItemNotFound | 1047 |
| PreconditionFailed | 1610 |
Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Given an entity type, entity identifier and container details, will subtract the specified inventory items.
Given an entity type, entity identifier and container details, will subtract the specified inventory items.
Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory. (Default=false)
The amount to subtract for the current item.
The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is unlimited.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The duration to subtract from the current item expiration date.
The entity to perform this action on.
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
The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.
The inventory item the request applies to.
