Inventory API
Manages game assets and player inventories.
The Game Provider interacts with the Inventory API to manage items that players can acquire, use, or trade during the game. This includes handling rewards, power-ups, and customization options.
Please insert JWT with Bearer into field
The unique identifier of the game for which initial items are to be retrieved.
If the initial items are successfully retrieved for the game.
No content
If an internal server error occurs while retrieving the initial items.
No content
Please insert JWT with Bearer into field
The unique identifier of the game for which the initial item is to be created.
If the initial item is successfully created.
No content
If the request body is invalid or the initial item already exists for the game.
If an internal server error occurs while creating the initial item.
No content
Please insert JWT with Bearer into field
The unique identifier of the item.
The unique identifier of the game.
If the item metadata is successfully retrieved.
No content
If the item ID or game ID is invalid or if the item cannot be retrieved.
If the item is not found in the specified game.
If an internal server error occurs while retrieving the item.
No content
Please insert JWT with Bearer into field
The ID of the game for which the items should be retrieved.
The name of the attribute used for searching items.
The value of the attribute used for searching items.
If the items are successfully retrieved based on the specified parameters.
No content
If there is an error in reading the items due to invalid parameters or failure in processing.
If an internal server error occurs while retrieving the items.
No content
Please insert JWT with Bearer into field
The unique identifier of the game.
Returns the game metadata.
If the gameId is invalid (null or empty).
If an internal server error occurs while retrieving the metadata.
Please insert JWT with Bearer into field
The unique identifier of the game.
Returns the newly created item.
If the gameId is invalid (null or empty) or if the request data is invalid.
If an internal server error occurs while creating the item.
Please insert JWT with Bearer into field
The unique identifier of the game.
The unique identifier of the item to be deleted.
If the item is successfully deleted.
No content
If the gameId or itemId is invalid (null or empty).
If an internal server error occurs while deleting the item.
No content
Please insert JWT with Bearer into field
The unique identifier of the game.
The unique identifier of the item to update.
If the item is successfully updated.
No content
If the gameId, itemId, or request data is invalid.
If an internal server error occurs while updating the item.
No content
Please insert JWT with Bearer into field
The unique identifier of the game.
The unique identifier of the item to update.
If the attribute is successfully added to the item.
No content
If the gameId, itemId, or request data is invalid.
If an internal server error occurs while adding the attribute.
No content
Please insert JWT with Bearer into field
The unique identifier of the game.
The unique identifier of the item from which the attribute will be deleted.
The unique identifier of the attribute to delete.
If the attribute is successfully deleted from the item.
No content
If any of the provided identifiers (gameId, itemId, attributeId) are invalid.
If an internal server error occurs while deleting the attribute.
No content
Please insert JWT with Bearer into field
The unique identifier of the game.
The unique identifier of the item to update the icon for.
The image file to be used as the icon for the item.
If the item icon is successfully updated.
No content
If the gameId, itemId, or file is invalid.
If an internal server error occurs while updating the item icon.
No content
Please insert JWT with Bearer into field
The unique identifier of the game.
An optional search keyword for filtering the entries.
OK
Bad Request
Internal Server Error
Please insert JWT with Bearer into field
The unique identifier of the game for which items are to be retrieved.
If the items are successfully retrieved for the game.
No content
If the provided gameId is invalid.
If an internal server error occurs while retrieving the items.
No content
Please insert JWT with Bearer into field
The unique identifier of the player.
The unique identifier of the game.
A flag indicating whether to retrieve detailed item information.
If the inventory is successfully retrieved.
No content
If the player ID or game ID is invalid or if the inventory cannot be retrieved.
If an internal server error occurs while retrieving the inventory.
No content
Please insert JWT with Bearer into field
The unique identifier of the player whose inventory will be updated.
The unique identifier of the game in which the inventory exists.
The unique identifier of the item to be added to the player's inventory.
The quantity of the item to be added (default is 1).
1If the item is successfully added to the player's inventory.
No content
If any of the parameters are invalid or the quantity is less than or equal to zero.
If an internal error occurs while processing the request.
No content
Please insert JWT with Bearer into field
The unique identifier of the player whose inventory will be updated.
The unique identifier of the game in which the inventory exists.
The unique identifier of the item to be removed from the player's inventory.
The quantity of the item to be removed (default is 1).
1If the item is successfully removed from the player's inventory.
No content
If any of the parameters are invalid or the quantity is less than or equal to zero.
If an internal error occurs while processing the request.
No content
Please insert JWT with Bearer into field
The unique identifier of the player.
The unique identifier of the game.
If the item is successfully retrieved from the player's inventory.
No content
If the player ID, game ID, or item ID is invalid, or if there is a failure in retrieving the item.
If the item is not found in the player's inventory.
If an internal server error occurs while retrieving the item.
No content
Please insert JWT with Bearer into field
The unique identifier of the player.
Successfully retrieved inventory items.
Failed to retrieve inventory items from the event store.
Transfers a specified quantity of an item from one player's inventory to another player's inventory across different games.
Please insert JWT with Bearer into field
The unique identifier of the player from whom the item will be transferred.
The unique identifier of the player to whom the item will be transferred.
If the item transfer is successful.
No content
If any of the parameters are invalid or missing.
If an internal error occurs during the transfer process.
No content
Please insert JWT with Bearer into field
ID of the player offering the item.
ID of the player receiving the item.
OK
No content
Bad Request
Internal Server Error
No content
Reverts the transfer of an item between players' inventories, undoing the previous transfer operation.
Please insert JWT with Bearer into field
The unique identifier of the transaction to be reverted.
The unique identifier of the source player involved in the original transfer.
The unique identifier of the source game involved in the original transfer.
The unique identifier of the item being reverted.
The unique identifier of the destination player involved in the original transfer.
The unique identifier of the destination game involved in the original transfer.
The quantity of the item to be reverted. Default is 1.
1If the item revert is successful.
No content
If any of the parameters are invalid or missing.
If an internal error occurs during the revert process.
No content
Please insert JWT with Bearer into field
The unique identifier of the initial item to be deleted.
If the initial item is successfully deleted.
No content
If the initial item identifier is invalid.
If the initial item with the specified ID is not found.
If an internal server error occurs while deleting the initial item.
No content
Please insert JWT with Bearer into field
The name of the attribute used for searching items.
The value of the attribute used for searching items.
If the items are successfully retrieved based on the specified attribute and value.
No content
If there is an error in reading the items due to invalid parameters or failure in processing.
If an internal server error occurs while retrieving the items.
No content
Please insert JWT with Bearer into field
The keyword to filter item types by name, description, or attributes.
OK
No content
Bad Request
Internal Server Error
No content
Please insert JWT with Bearer into field
OK
No content
Bad Request
Internal Server Error
No content
Please insert JWT with Bearer into field
The ID of the item type to be deleted.
OK
No content
Bad Request
Not Found
Conflict
Internal Server Error
No content
Please insert JWT with Bearer into field
The ID of the item type to which the attribute will be added.
OK
No content
Bad Request
Internal Server Error
No content
Please insert JWT with Bearer into field
The ID of the item type whose attribute will be deleted.
The ID of the attribute to be deleted.
OK
No content
Bad Request
Not Found
Internal Server Error
No content
Please insert JWT with Bearer into field
USDOK
OK
Please insert JWT with Bearer into field
USDOK
No content
OK
No content
Please insert JWT with Bearer into field
USDOK
No content
OK
No content
Last updated