Consume Item
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Consume uses of a consumable item. When all uses are consumed, it will be removed from the player’s inventory.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| CharacterNotFound | 1135 |
| InvalidItemProperties | 1091 |
| ItemNotFound | 1047 |
| NoRemainingUses | 1062 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
Number of uses to consume from the item.
Unique instance identifier of the item to be consumed.
Unique PlayFab assigned ID of the user on whom the operation will be performed.
Unique PlayFab assigned ID for a specific character owned by a user
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
