Generate Sandbox Diff
GET /experimental/v1/sandbox-diff
Authorizations
Parameters
Query Parameters
Responses
200
Successful Response
object
object
An Item. Item come in a couple of different flavors; determined by the type field.
Unit items are stored in a player’s catalog.
Recipe items are not stored in a player’s catalog and are used to fulfill SubVendor Loot.
RecipeWithPriceReduction items are not stored in a player’s catalog and are used to fulfill SubVendor Loot but at a reduced cost if the Player owns some of the Loot.
Entitlement items are stored in a player’s catalog and are fulfilled to the player each time an Inventory Session is created and when the Entitlement is fulfilled to the Player.
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
The type of item.
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.
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.
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.
The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.
The amount the price is discounted. This is a percentage between 0 and 1. For example, 0.25 would be a 25% discount.
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.
List of Loot IDs this item can discount
Name of corresponding currency Item ID
The Item ID of the currency to be used for the coupon.
ID of the Sandbox
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
The Item ID.
The Legacy Item ID.
Name corresponding entitled Loot ID
Name of corresponding level Vendor ID
Name of corresponding level XP Table ID
Name of corresponding Inventory Bucket Use Rule Set ID
An Item. Item come in a couple of different flavors; determined by the type field.
Unit items are stored in a player’s catalog.
Recipe items are not stored in a player’s catalog and are used to fulfill SubVendor Loot.
RecipeWithPriceReduction items are not stored in a player’s catalog and are used to fulfill SubVendor Loot but at a reduced cost if the Player owns some of the Loot.
Entitlement items are stored in a player’s catalog and are fulfilled to the player each time an Inventory Session is created and when the Entitlement is fulfilled to the Player.
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
The type of item.
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.
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.
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.
The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.
The amount the price is discounted. This is a percentage between 0 and 1. For example, 0.25 would be a 25% discount.
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.
List of Loot IDs this item can discount
Name of corresponding currency Item ID
The Item ID of the currency to be used for the coupon.
ID of the Sandbox
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
The Item ID.
The Legacy Item ID.
Name corresponding entitled Loot ID
Name of corresponding level Vendor ID
Name of corresponding level XP Table ID
Name of corresponding Inventory Bucket Use Rule Set ID
object
This mixin is meant to give a set of common properties to root config models
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
ID of the Sandbox
The ID of the Vendor.
The legacy ID of the Vendor.
Determines how the Vendor fulfills the loot.
The Loot the Vendor will fulfill.
Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.
The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.
The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.
The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.
The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.
Determines if the Loot is active. Inactive Loot will not be fulfilled.
The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.
The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.
When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.
When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player
Item required to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor
Determines how the quantity is modified in the context it is fulfilled in.
When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.
Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
Inventory Bucket to use for this Loot.
Allows treating quantity as additional levels to grant to the Player.
The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.
The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.
Hard cap on quantity of an item this Loot can give. Disabled with 0
ID of the Sandbox
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
The Loot ID
The Vendor ID
The legacy ID of the Loot.
Name corresponding Vendor ID
Name corresponding Sub-Vendor ID
Name corresponding Item ID
Name corresponding Required Item ID
Name corresponding Quantity Multi Inventory Item ID
Name corresponding Current Price Point ID
Name corresponding Pre-sale Price Point ID
This mixin is meant to give a set of common properties to root config models
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
ID of the Sandbox
The ID of the Vendor.
The legacy ID of the Vendor.
Determines how the Vendor fulfills the loot.
The Loot the Vendor will fulfill.
Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.
The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.
The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.
The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.
The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.
Determines if the Loot is active. Inactive Loot will not be fulfilled.
The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.
The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.
When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.
When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player
Item required to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor
Determines how the quantity is modified in the context it is fulfilled in.
When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.
Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
Inventory Bucket to use for this Loot.
Allows treating quantity as additional levels to grant to the Player.
The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.
The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.
Hard cap on quantity of an item this Loot can give. Disabled with 0
ID of the Sandbox
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
The Loot ID
The Vendor ID
The legacy ID of the Loot.
Name corresponding Vendor ID
Name corresponding Sub-Vendor ID
Name corresponding Item ID
Name corresponding Required Item ID
Name corresponding Quantity Multi Inventory Item ID
Name corresponding Current Price Point ID
Name corresponding Pre-sale Price Point ID
object
Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.
The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.
The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.
The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.
The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.
Determines if the Loot is active. Inactive Loot will not be fulfilled.
The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.
The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.
When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.
When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player
Item required to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor
Determines how the quantity is modified in the context it is fulfilled in.
When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.
Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
Inventory Bucket to use for this Loot.
Allows treating quantity as additional levels to grant to the Player.
The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.
The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.
Hard cap on quantity of an item this Loot can give. Disabled with 0
ID of the Sandbox
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
The Loot ID
The Vendor ID
The legacy ID of the Loot.
Name corresponding Vendor ID
Name corresponding Sub-Vendor ID
Name corresponding Item ID
Name corresponding Required Item ID
Name corresponding Quantity Multi Inventory Item ID
Name corresponding Current Price Point ID
Name corresponding Pre-sale Price Point ID
Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.
object
Custom data associated with the resource
object
Name of the resource
Description of the resource
The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.
The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.
The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.
The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.
The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.
Determines if the Loot is active. Inactive Loot will not be fulfilled.
The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.
The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.
When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.
When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player
Item required to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor
Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor
Determines how the quantity is modified in the context it is fulfilled in.
When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.
Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.
Inventory Bucket to use for this Loot.
Allows treating quantity as additional levels to grant to the Player.
The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.
The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.
Hard cap on quantity of an item this Loot can give. Disabled with 0
ID of the Sandbox
Account ID of the user who last modified the resource
Timestamp of when the resource was last modified
Timestamp of when the resource was created
The Loot ID
The Vendor ID
The legacy ID of the Loot.
Name corresponding Vendor ID
Name corresponding Sub-Vendor ID
Name corresponding Item ID
Name corresponding Required Item ID
Name corresponding Quantity Multi Inventory Item ID
Name corresponding Current Price Point ID
Name corresponding Pre-sale Price Point ID
422
Validation Error