inventory

name	inventory
description	Use playfab-cli to manage Economy v2 player inventory including add, subtract, delete, transfer items, purchases, and platform redemptions. Use when the user needs to manage player inventory items, virtual currencies, or process purchases. Do not use for catalog item management or legacy v1 inventory APIs.
allowed-tools	Bash, Read, Grep, Glob
metadata	{"author":"akiojin","version":"0.2.0","category":"economy"}

Inventory Operations

Use playfab-cli to manage Economy v2 Inventory for players.

Use When

• The user needs to add, subtract, delete, or transfer inventory items.
• The user wants to process purchases or redeem platform store receipts.
• The user needs to check player inventory or transaction history.
• The task involves Economy v2 inventory operations.
• The user needs to grant items to multiple users in batch.

Do Not Use When

• The operation manages catalog items (use catalog skill).
• The operation uses legacy v1 inventory APIs (use admin or server skill).
• The user only needs to inspect item definitions without player context.

Available Tools

Tool	Description
add_inventory_items	Add items to a player's inventory
subtract_inventory_items	Subtract items from a player's inventory
delete_inventory_items	Delete items from a player's inventory
update_inventory_items	Update inventory item properties
get_inventory_items	Get a player's inventory items
get_inventory_collection_ids	Get collection IDs for a player's inventory
execute_inventory_operations	Execute multiple operations atomically
purchase_inventory_items	Purchase an item from the catalog
transfer_inventory_items	Transfer items between entities
execute_transfer_operations	Execute multiple transfers atomically
grant_items_to_users	Grant items to multiple users in a batch
get_transaction_history	Get transaction history for an entity
get_inventory_operation_status	Get status of an inventory operation
redeem_apple_appstore_inventory_items	Redeem Apple App Store purchase
redeem_google_play_inventory_items	Redeem Google Play purchase
redeem_microsoft_store_inventory_items	Redeem Microsoft Store purchase
redeem_nintendo_eshop_inventory_items	Redeem Nintendo eShop purchase
redeem_playstation_store_inventory_items	Redeem PlayStation Store purchase
redeem_steam_inventory_items	Redeem Steam purchase
get_microsoft_store_access_tokens	Get Microsoft Store access tokens

Examples

Get player inventory

playfab-cli tool call get_inventory_items --json '{
  "entity": {"Id": "ABCD1234", "Type": "title_player_account"}
}'

Add items to inventory

playfab-cli tool call add_inventory_items --json '{
  "entity": {"Id": "ABCD1234", "Type": "title_player_account"},
  "item": {"Id": "sword-001"},
  "amount": 1
}'

Subtract items

playfab-cli tool call subtract_inventory_items --json '{
  "entity": {"Id": "ABCD1234", "Type": "title_player_account"},
  "item": {"Id": "gold-coin"},
  "amount": 100
}'

Purchase an item

playfab-cli tool call purchase_inventory_items --json '{
  "entity": {"Id": "ABCD1234", "Type": "title_player_account"},
  "item": {"Id": "sword-001"},
  "amount": 1,
  "priceAmounts": [{"ItemId": "gold-coin", "Amount": 500}],
  "storeId": "main-store"
}'

Transfer items between players

playfab-cli tool call transfer_inventory_items --json '{
  "givingEntity": {"Id": "PLAYER_A", "Type": "title_player_account"},
  "receivingEntity": {"Id": "PLAYER_B", "Type": "title_player_account"},
  "item": {"Id": "sword-001"},
  "amount": 1
}'

Atomic multi-operation

playfab-cli tool call execute_inventory_operations --json '{
  "entity": {"Id": "ABCD1234", "Type": "title_player_account"},
  "operations": [
    {"Subtract": {"Item": {"Id": "gold-coin"}, "Amount": 500}},
    {"Add": {"Item": {"Id": "sword-001"}, "Amount": 1}}
  ]
}'

Grant items to multiple users

playfab-cli tool call grant_items_to_users --json '{
  "items": [
    {
      "PlayFabId": "PLAYER_A",
      "items": [{"Id": "reward-001", "Amount": 1}]
    },
    {
      "PlayFabId": "PLAYER_B",
      "items": [{"Id": "reward-001", "Amount": 1}]
    }
  ]
}'

Get transaction history

playfab-cli tool call get_transaction_history --json '{
  "entity": {"Id": "ABCD1234", "Type": "title_player_account"},
  "count": 20
}'

Common Workflows

1. Check and modify inventory

# List inventory
playfab-cli tool call get_inventory_items --json '{"entity": {"Id": "...", "Type": "title_player_account"}}'
# Add item
playfab-cli tool call add_inventory_items --json '{"entity": {"Id": "...", "Type": "title_player_account"}, "item": {"Id": "item-id"}, "amount": 1}'
# Verify
playfab-cli tool call get_inventory_items --json '{"entity": {"Id": "...", "Type": "title_player_account"}}'

2. Virtual currency management

Virtual currencies are inventory items in Economy v2:

# Check balance
playfab-cli tool call get_inventory_items --json '{"entity": {"Id": "...", "Type": "title_player_account"}, "filter": "type eq '\''currency'\''"}'
# Add currency
playfab-cli tool call add_inventory_items --json '{"entity": {"Id": "...", "Type": "title_player_account"}, "item": {"Id": "gold-coin"}, "amount": 1000}'

Notes

• All inventory operations use Economy v2 API.
• Virtual currencies are inventory items in Economy v2 -- use the same add/subtract tools.
• execute_inventory_operations supports atomic multi-step operations (max 10 per call).
• Rate limit: execute_inventory_operations is limited to 60 requests per 90 seconds per player entity.
• grant_items_to_users is a title-level batch operation with more generous rate limits.