Items

_{Version: 1.0.0.0 Updated: 2023-11-29 16:56:05}

Summary

Documentation for the Items Page

Items Schema

Name	Type	Required	Description
custom_data	object	No	Custom data associated with the resource
name	string	No	Name of the resource
description	string	No	Description of the resource
item_type	object	No	See schema
entitled_loot_id	string	No	This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot ID that will be fulfilled.
level_xp_table_id	string	No	The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.
level_vendor_id	string	No	The vendor containing the rewards to grant to the player as they level up. If a `level_xp_table_id` is configured, when this item is granted to a player their quantity is converted to a level using that table and rewards are granted based on the `sort_order` of loot inside this reward vendor. If there is no `level_xp_table_id` configured, the quantity is used to select loot to grant from this reward vendor. This is only valid for an unit Item.
inventory_bucket_use_rule_set_id	string	No	The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.
coupon_discount_percentage	number	No	The amount the price is discounted. This is a percentage between 0 and 1. For example, 0.25 would be a 25% discount.
coupon_consume_on_use	boolean	No	If true, the coupon will be consumed when used by decreasing the quantity in the Player’s Inventory by 1. If false, the coupon will remain in the Player’s inventory after use.
coupon_discount_loot	array	No	List of Loot IDs this item can discount
coupon_discount_currency_item_name	string	No	Name of corresponding currency Item ID
coupon_discount_currency_item_id	string	No	The Item ID of the currency to be used for the coupon.
sandbox_id	string	No	ID of the Sandbox
last_modified_account_id	string	No	Account ID of the user who last modified the resource
last_modified_timestamp	string	No	Timestamp of when the resource was last modified
created_timestamp	string	No	Timestamp of when the resource was created
item_id	string	Yes	The Item ID.
legacy_item_id	integer	No	The Legacy Item ID.
entitled_loot_name	string	No	Name corresponding entitled Loot ID
level_vendor_name	string	No	Name of corresponding level Vendor ID
level_xp_table_name	string	No	Name of corresponding level XP Table ID
inventory_bucket_use_rule_set_name	string	No	Name of corresponding Inventory Bucket Use Rule Set ID

Item_type Enum Values

Value	Description
unit	An item that is stored in a player’s catalog.
recipe	A Loot with the ItemType receipt will fulfill SubVendor Loot and will not stored in a player’s catalog.
recipe_with_price_reduction	The same as `ItemType.recipe` but will reduce the price based on whether or not the player owns items in the SubVendor’s Loot table.
entitlement	An entitlement is a special item that is stored in a player’s catalog and is fulfilled to the player each time an Inventory Session is created and when the Entitlement is fulfilled to the Player.