Use playfab-cli to manage Economy v2 Catalog items including search, CRUD, bundles, stores, subscriptions, and moderation. Use when the user needs to create, search, update, publish, or delete catalog items. Do not use for inventory operations on player accounts or for legacy v1 economy APIs.
Use playfab-cli to manage Economy v2 Catalog items.
| Tool | Description |
|---|---|
search_items | Search catalog items with optional filter, search, and orderBy |
get_item | Retrieve a specific catalog item by ID |
get_items | Retrieve multiple published catalog items by IDs |
create_draft_item | Create a new draft catalog item |
update_draft_item | Update an existing draft catalog item |
publish_draft_item | Publish a draft item to make it live |
delete_item | Delete a catalog item by ID |
get_draft_items | Retrieve multiple draft items by IDs |
get_entity_draft_items | Retrieve all draft items owned by an entity |
batch_create_draft_items | Create multiple draft items in a batch |
get_catalog_config | Retrieve the catalog configuration |
update_catalog_config | Update the catalog configuration |
create_upload_urls | Create URLs for uploading content files |
get_item_moderation_state | Get moderation state of an item |
set_item_moderation_state | Set moderation state of an item |
get_item_publish_status | Get publish status of an item |
get_item_reviews | Get reviews for an item |
submit_item_review_vote | Vote on an item review |
takedown_item_reviews | Remove reviews (moderation) |
report_item | Report an item for policy violations |
get_item_containers | Get containers referencing an item |
create_bundle | Create a draft bundle item |
create_store | Create a draft store item |
create_subscription | Create a draft subscription item |
get_store_by_friendly_id | Retrieve a store by friendly ID |
create_recipe | Create a crafting recipe |
playfab-cli tool call search_items --json '{"search": "sword", "count": 10}'
playfab-cli tool call search_items --json '{"filter": "type eq '\''catalogItem'\''", "orderBy": "title/en-US asc", "count": 25}'
playfab-cli tool call get_item --json '{"id": "item-123"}'
playfab-cli tool call get_items --json '{"ids": ["item-001", "item-002", "item-003"]}'
playfab-cli tool call create_draft_item --json '{
"item": {
"Type": "catalogItem",
"Title": {"NEUTRAL": "Iron Sword"},
"Description": {"NEUTRAL": "A sturdy iron sword"},
"StartDate": "2024-01-01T00:00:00Z"
},
"publish": false
}'
playfab-cli tool call publish_draft_item --json '{"id": "item-123"}'
playfab-cli tool call delete_item --json '{"id": "item-123"}'
playfab-cli tool call create_store --json '{
"item": {
"Title": {"NEUTRAL": "Main Shop"},
"Description": {"NEUTRAL": "The main in-game store"}
},
"publish": true
}'
playfab-cli tool call create_bundle --json '{
"item": {
"Title": {"NEUTRAL": "Starter Pack"},
"ItemReferences": [
{"Id": "item-001", "Amount": 1},
{"Id": "item-002", "Amount": 5}
]
},
"publish": false
}'
# Create draft
playfab-cli tool call create_draft_item --json '{"item": {...}}'
# Review draft
playfab-cli tool call get_entity_draft_items --json '{"entity": {"Id": "...", "Type": "title"}}'
# Publish
playfab-cli tool call publish_draft_item --json '{"id": "item-123"}'
# Verify
playfab-cli tool call get_item --json '{"id": "item-123"}'
# Check moderation state
playfab-cli tool call get_item_moderation_state --json '{"id": "item-123"}'
# Set moderation state
playfab-cli tool call set_item_moderation_state --json '{"id": "item-123", "status": "Approved", "reason": "Content reviewed"}'
publish_draft_item before they appear in searches.batch_create_draft_items for bulk item creation to reduce API calls.get_item_moderation_state, set_item_moderation_state) are admin-level operations.