Generate Sandbox Diff

GET 
/experimental/v1/sandbox-diff

Generate Sandbox Diff

Request

Query Parameters

left_sandbox_id uuidrequired
right_sandbox_id uuidrequired

Responses

200

Successful Response

application/json

Schema

Schema

items

object[]

Array [

left

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.

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

item_type Item Type (string)

Possible values: [unit, recipe, recipe_with_price_reduction, entitlement]

The type of item.

entitled_loot_id uuid

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 uuid

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 uuid

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 uuid

The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.

coupon_discount_percentage Coupon Discount Percentage (number)

Possible values: > 0 and <= 1

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 Coupon Consume On Use (boolean)

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 uuid[]

Default value: ``

List of Loot IDs this item can discount

coupon_discount_currency_item_name Coupon Discount Currency Item Name (string)

Name of corresponding currency Item ID

coupon_discount_currency_item_id uuid

The Item ID of the currency to be used for the coupon.

total_ownership_max Total Ownership Max (integer)

Default value: 0

Maximum ownership (permanent+rental) count that a player is allowed for this item ID

legacy_item_id Legacy Item Id (integer)

The Legacy Item ID.

sandbox_id uuid

ID of the Sandbox

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

item_id uuidrequired

The Item ID.

entitled_loot_name Entitled Loot Name (string)

Name corresponding entitled Loot ID

level_vendor_name Level Vendor Name (string)

Name of corresponding level Vendor ID

level_xp_table_name Level Xp Table Name (string)

Name of corresponding level XP Table ID

inventory_bucket_use_rule_set_name Inventory Bucket Use Rule Set Name (string)

Name of corresponding Inventory Bucket Use Rule Set ID

right

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.

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

item_type Item Type (string)

Possible values: [unit, recipe, recipe_with_price_reduction, entitlement]

The type of item.

entitled_loot_id uuid

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 uuid

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 uuid

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 uuid

The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.

coupon_discount_percentage Coupon Discount Percentage (number)

Possible values: > 0 and <= 1

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 Coupon Consume On Use (boolean)

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 uuid[]

Default value: ``

List of Loot IDs this item can discount

coupon_discount_currency_item_name Coupon Discount Currency Item Name (string)

Name of corresponding currency Item ID

coupon_discount_currency_item_id uuid

The Item ID of the currency to be used for the coupon.

total_ownership_max Total Ownership Max (integer)

Default value: 0

Maximum ownership (permanent+rental) count that a player is allowed for this item ID

legacy_item_id Legacy Item Id (integer)

The Legacy Item ID.

sandbox_id uuid

ID of the Sandbox

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

item_id uuidrequired

The Item ID.

entitled_loot_name Entitled Loot Name (string)

Name corresponding entitled Loot ID

level_vendor_name Level Vendor Name (string)

Name of corresponding level Vendor ID

level_xp_table_name Level Xp Table Name (string)

Name of corresponding level XP Table ID

inventory_bucket_use_rule_set_name Inventory Bucket Use Rule Set Name (string)

Name of corresponding Inventory Bucket Use Rule Set ID

]

vendors

object[]

Array [

left

object

This mixin is meant to give a set of common properties to root config models

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

sandbox_id uuid

ID of the Sandbox

vendor_id uuidrequired

The ID of the Vendor.

legacy_vendor_id Legacy Vendor Id (integer)

Default value: 0

The legacy ID of the Vendor.

vendor_type Vendor Type (string)

Possible values: [recipe, randomly_sampled]

Determine how the Vendor fulfills the Loot.

loot

object[]

The Loot the Vendor will fulfill.

Array [

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

item_id uuid

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

sub_vendor_id uuid

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

quantity Quantity (integer)

Default value: 1

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.

inventory_selector_type Inventory Selector (string)required

Possible values: [own, rent, rent_timeframe_locked, own_transient, inherit_entitlement_inventory]

Determines way Inventory is selected and how it is to be modified.

inventory_operation Inventory Operation (string)required

Possible values: [add, subtract, set, check_greater_than_or_equal, check_less_than, check_greater_than_or_equal_and_subtract]

Determines how the Inventory Quantity will be acted upon and the sort order of Loot in a Vendor if the Loot has the same sort order.

Sort Order:

1. check_greater_then_or_equal/check_less_than
2. check_greater_than_or_equal_and_subtract/subtract
3. add/set

active Active (boolean)

Determines if the Loot is active. Inactive Loot will not be fulfilled.

sort_order Sort Order (integer)

Default value: 0

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.

drop_weight Drop Weight (integer)

Default value: 0

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

fill_in_new_order Fill In New Order (boolean)

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.

allow_partial_bundles Allow Partial Bundles (boolean)

Default value: true

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

required_item_id uuid

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

required_item_count Required Item Count (integer)

Default value: 0

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

stack_limit Stack Limit (integer)

Default value: 0

Amount of owned/rented of this Loot's item that will prevent this Loot from dropping in a randomly sampled vendor

quantity_type Quantity Type (string)

Possible values: [relative, absolute]

Determines how the quantity is to be modified.

Relative looks at the context in which is fulfilled; e.g. If Loot A has a quantity of 2 and 5 is being fulfill, the resulting quantity modification will be 10.

Absolute ignores the context in which it is fulfilled; e.g. If Loot B has a quantity of 3 and 5 is being fulfill 5, the resulting quantity modification will be 3.

quantity_multi_inventory_item_id uuid

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player's Inventory.

is_claimable_by_client Is Claimable By Client (boolean)

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.

legacy_time_frame_id Legacy Time Frame Id (integer)

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

time_frame_id uuid

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

use_inventory_bucket Inventory Bucket (string)

Possible values: [free, sweat, none, anon, amazon, steam, psn, xbox_live, google, twitch, nintendo_switch, apple, nintendo, epic, google_play, nintendo_ppid]

Grouping of Inventory Items. Inventory items are grouped into different buckets as each Platform that is supported has different requirements on how Inventory can be used on their Platform and other Platforms.

xp_quantity_transform_type XP Quantity Transform (string)

Possible values: [none, from_current_xp_to_target_additional_level_min_xp, from_current_level_min_xp_to_target_additional_level_min_xp, from_zero_to_target_exact_level_min_xp]

Allows granting xp levels as Loot. If the player is already max level, the Loot will not be fulfilled. Requires the Item assigned to the Loot to have an XP Table ID.

The following examples assume the player is level 3 with 150 total xp. The quantity configured on the Loot being fulfilled is 1. The XP Table is configured like so: 1: 20 2: 50 3: 100 4: 200 5: 400

from_current_xp_to_target_additional_level_min_xp - The Loot will grant the player enough xp to reach min xp of the next level. Example 1: fulfill quantity 1 Player will be level 4 with 200 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 400 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 400 total xp.

from_current_level_min_xp_to_target_additional_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the next level from the min xp of the current level. Example 1: fulfill quantity 1 Player will be level 4 with 250 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 450 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 450 total xp.

from_zero_to_target_exact_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the target level from zero xp. Example 1: fulfill quantity 1 Player will be level 3 with 170 total xp. Example 2: fulfill quantity 2 Player will be level 4 with 200 total xp. Example 3: fulfill quantity 3 Player will be level 4 with 250 total xp.

current_price_point_id uuid

The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

pre_sale_price_point_id uuid

The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.

hard_quantity_maximum Hard Quantity Maximum (integer)

Default value: 0

Hard cap on quantity of an item this Loot can give. Disabled with 0

legacy_loot_id Legacy Loot Id (integer)

Default value: 0

The legacy ID of the Loot.

sandbox_id uuid

ID of the Sandbox

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

loot_id uuidrequired

The Loot ID

vendor_id uuidrequired

The Vendor ID

vendor_name Vendor Name (string)

Name corresponding Vendor ID

sub_vendor_name Sub Vendor Name (string)

Name corresponding Sub-Vendor ID

item_name Item Name (string)

Name corresponding Item ID

required_item_name Required Item Name (string)

Name corresponding Required Item ID

quantity_multi_inventory_item_name Quantity Multi Inventory Item Name (string)

Name corresponding Quantity Multi Inventory Item ID

current_price_point_name Current Price Point Name (string)

Name corresponding Current Price Point ID

pre_sale_price_point_name Pre Sale Price Point Name (string)

Name corresponding Pre-sale Price Point ID

]

right

object

This mixin is meant to give a set of common properties to root config models

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

sandbox_id uuid

ID of the Sandbox

vendor_id uuidrequired

The ID of the Vendor.

legacy_vendor_id Legacy Vendor Id (integer)

Default value: 0

The legacy ID of the Vendor.

vendor_type Vendor Type (string)

Possible values: [recipe, randomly_sampled]

Determine how the Vendor fulfills the Loot.

loot

object[]

The Loot the Vendor will fulfill.

Array [

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

item_id uuid

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

sub_vendor_id uuid

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

quantity Quantity (integer)

Default value: 1

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.

inventory_selector_type Inventory Selector (string)required

Possible values: [own, rent, rent_timeframe_locked, own_transient, inherit_entitlement_inventory]

Determines way Inventory is selected and how it is to be modified.

inventory_operation Inventory Operation (string)required

Possible values: [add, subtract, set, check_greater_than_or_equal, check_less_than, check_greater_than_or_equal_and_subtract]

Determines how the Inventory Quantity will be acted upon and the sort order of Loot in a Vendor if the Loot has the same sort order.

Sort Order:

1. check_greater_then_or_equal/check_less_than
2. check_greater_than_or_equal_and_subtract/subtract
3. add/set

active Active (boolean)

Determines if the Loot is active. Inactive Loot will not be fulfilled.

sort_order Sort Order (integer)

Default value: 0

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.

drop_weight Drop Weight (integer)

Default value: 0

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

fill_in_new_order Fill In New Order (boolean)

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.

allow_partial_bundles Allow Partial Bundles (boolean)

Default value: true

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

required_item_id uuid

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

required_item_count Required Item Count (integer)

Default value: 0

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

stack_limit Stack Limit (integer)

Default value: 0

Amount of owned/rented of this Loot's item that will prevent this Loot from dropping in a randomly sampled vendor

quantity_type Quantity Type (string)

Possible values: [relative, absolute]

Determines how the quantity is to be modified.

Relative looks at the context in which is fulfilled; e.g. If Loot A has a quantity of 2 and 5 is being fulfill, the resulting quantity modification will be 10.

Absolute ignores the context in which it is fulfilled; e.g. If Loot B has a quantity of 3 and 5 is being fulfill 5, the resulting quantity modification will be 3.

quantity_multi_inventory_item_id uuid

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player's Inventory.

is_claimable_by_client Is Claimable By Client (boolean)

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.

legacy_time_frame_id Legacy Time Frame Id (integer)

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

time_frame_id uuid

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

use_inventory_bucket Inventory Bucket (string)

Possible values: [free, sweat, none, anon, amazon, steam, psn, xbox_live, google, twitch, nintendo_switch, apple, nintendo, epic, google_play, nintendo_ppid]

Grouping of Inventory Items. Inventory items are grouped into different buckets as each Platform that is supported has different requirements on how Inventory can be used on their Platform and other Platforms.

xp_quantity_transform_type XP Quantity Transform (string)

Possible values: [none, from_current_xp_to_target_additional_level_min_xp, from_current_level_min_xp_to_target_additional_level_min_xp, from_zero_to_target_exact_level_min_xp]

Allows granting xp levels as Loot. If the player is already max level, the Loot will not be fulfilled. Requires the Item assigned to the Loot to have an XP Table ID.

The following examples assume the player is level 3 with 150 total xp. The quantity configured on the Loot being fulfilled is 1. The XP Table is configured like so: 1: 20 2: 50 3: 100 4: 200 5: 400

from_current_xp_to_target_additional_level_min_xp - The Loot will grant the player enough xp to reach min xp of the next level. Example 1: fulfill quantity 1 Player will be level 4 with 200 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 400 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 400 total xp.

from_current_level_min_xp_to_target_additional_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the next level from the min xp of the current level. Example 1: fulfill quantity 1 Player will be level 4 with 250 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 450 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 450 total xp.

from_zero_to_target_exact_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the target level from zero xp. Example 1: fulfill quantity 1 Player will be level 3 with 170 total xp. Example 2: fulfill quantity 2 Player will be level 4 with 200 total xp. Example 3: fulfill quantity 3 Player will be level 4 with 250 total xp.

current_price_point_id uuid

The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

pre_sale_price_point_id uuid

The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.

hard_quantity_maximum Hard Quantity Maximum (integer)

Default value: 0

Hard cap on quantity of an item this Loot can give. Disabled with 0

legacy_loot_id Legacy Loot Id (integer)

Default value: 0

The legacy ID of the Loot.

sandbox_id uuid

ID of the Sandbox

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

loot_id uuidrequired

The Loot ID

vendor_id uuidrequired

The Vendor ID

vendor_name Vendor Name (string)

Name corresponding Vendor ID

sub_vendor_name Sub Vendor Name (string)

Name corresponding Sub-Vendor ID

item_name Item Name (string)

Name corresponding Item ID

required_item_name Required Item Name (string)

Name corresponding Required Item ID

quantity_multi_inventory_item_name Quantity Multi Inventory Item Name (string)

Name corresponding Quantity Multi Inventory Item ID

current_price_point_name Current Price Point Name (string)

Name corresponding Current Price Point ID

pre_sale_price_point_name Pre Sale Price Point Name (string)

Name corresponding Pre-sale Price Point ID

]

]

loot

object[]

Array [

left

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.

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

item_id uuid

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

sub_vendor_id uuid

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

quantity Quantity (integer)

Default value: 1

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.

inventory_selector_type Inventory Selector (string)required

Possible values: [own, rent, rent_timeframe_locked, own_transient, inherit_entitlement_inventory]

Determines way Inventory is selected and how it is to be modified.

inventory_operation Inventory Operation (string)required

Possible values: [add, subtract, set, check_greater_than_or_equal, check_less_than, check_greater_than_or_equal_and_subtract]

Determines how the Inventory Quantity will be acted upon and the sort order of Loot in a Vendor if the Loot has the same sort order.

Sort Order:

1. check_greater_then_or_equal/check_less_than
2. check_greater_than_or_equal_and_subtract/subtract
3. add/set

active Active (boolean)

Determines if the Loot is active. Inactive Loot will not be fulfilled.

sort_order Sort Order (integer)

Default value: 0

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.

drop_weight Drop Weight (integer)

Default value: 0

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

fill_in_new_order Fill In New Order (boolean)

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.

allow_partial_bundles Allow Partial Bundles (boolean)

Default value: true

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

required_item_id uuid

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

required_item_count Required Item Count (integer)

Default value: 0

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

stack_limit Stack Limit (integer)

Default value: 0

Amount of owned/rented of this Loot's item that will prevent this Loot from dropping in a randomly sampled vendor

quantity_type Quantity Type (string)

Possible values: [relative, absolute]

Determines how the quantity is to be modified.

Relative looks at the context in which is fulfilled; e.g. If Loot A has a quantity of 2 and 5 is being fulfill, the resulting quantity modification will be 10.

Absolute ignores the context in which it is fulfilled; e.g. If Loot B has a quantity of 3 and 5 is being fulfill 5, the resulting quantity modification will be 3.

quantity_multi_inventory_item_id uuid

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player's Inventory.

is_claimable_by_client Is Claimable By Client (boolean)

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.

legacy_time_frame_id Legacy Time Frame Id (integer)

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

time_frame_id uuid

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

use_inventory_bucket Inventory Bucket (string)

Possible values: [free, sweat, none, anon, amazon, steam, psn, xbox_live, google, twitch, nintendo_switch, apple, nintendo, epic, google_play, nintendo_ppid]

Grouping of Inventory Items. Inventory items are grouped into different buckets as each Platform that is supported has different requirements on how Inventory can be used on their Platform and other Platforms.

xp_quantity_transform_type XP Quantity Transform (string)

Possible values: [none, from_current_xp_to_target_additional_level_min_xp, from_current_level_min_xp_to_target_additional_level_min_xp, from_zero_to_target_exact_level_min_xp]

Allows granting xp levels as Loot. If the player is already max level, the Loot will not be fulfilled. Requires the Item assigned to the Loot to have an XP Table ID.

The following examples assume the player is level 3 with 150 total xp. The quantity configured on the Loot being fulfilled is 1. The XP Table is configured like so: 1: 20 2: 50 3: 100 4: 200 5: 400

from_current_xp_to_target_additional_level_min_xp - The Loot will grant the player enough xp to reach min xp of the next level. Example 1: fulfill quantity 1 Player will be level 4 with 200 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 400 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 400 total xp.

from_current_level_min_xp_to_target_additional_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the next level from the min xp of the current level. Example 1: fulfill quantity 1 Player will be level 4 with 250 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 450 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 450 total xp.

from_zero_to_target_exact_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the target level from zero xp. Example 1: fulfill quantity 1 Player will be level 3 with 170 total xp. Example 2: fulfill quantity 2 Player will be level 4 with 200 total xp. Example 3: fulfill quantity 3 Player will be level 4 with 250 total xp.

current_price_point_id uuid

The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

pre_sale_price_point_id uuid

The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.

hard_quantity_maximum Hard Quantity Maximum (integer)

Default value: 0

Hard cap on quantity of an item this Loot can give. Disabled with 0

legacy_loot_id Legacy Loot Id (integer)

Default value: 0

The legacy ID of the Loot.

sandbox_id uuid

ID of the Sandbox

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

loot_id uuidrequired

The Loot ID

vendor_id uuidrequired

The Vendor ID

vendor_name Vendor Name (string)

Name corresponding Vendor ID

sub_vendor_name Sub Vendor Name (string)

Name corresponding Sub-Vendor ID

item_name Item Name (string)

Name corresponding Item ID

required_item_name Required Item Name (string)

Name corresponding Required Item ID

quantity_multi_inventory_item_name Quantity Multi Inventory Item Name (string)

Name corresponding Quantity Multi Inventory Item ID

current_price_point_name Current Price Point Name (string)

Name corresponding Current Price Point ID

pre_sale_price_point_name Pre Sale Price Point Name (string)

Name corresponding Pre-sale Price Point ID

right

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.

custom_data

object

Custom data associated with the resource

property name* string

name Name (string)

Possible values: non-empty and <= 125 characters

Name of the resource

description Description (string)

Possible values: <= 250 characters

Description of the resource

item_id uuid

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

sub_vendor_id uuid

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

quantity Quantity (integer)

Default value: 1

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.

inventory_selector_type Inventory Selector (string)required

Possible values: [own, rent, rent_timeframe_locked, own_transient, inherit_entitlement_inventory]

Determines way Inventory is selected and how it is to be modified.

inventory_operation Inventory Operation (string)required

Possible values: [add, subtract, set, check_greater_than_or_equal, check_less_than, check_greater_than_or_equal_and_subtract]

Determines how the Inventory Quantity will be acted upon and the sort order of Loot in a Vendor if the Loot has the same sort order.

Sort Order:

1. check_greater_then_or_equal/check_less_than
2. check_greater_than_or_equal_and_subtract/subtract
3. add/set

active Active (boolean)

Determines if the Loot is active. Inactive Loot will not be fulfilled.

sort_order Sort Order (integer)

Default value: 0

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.

drop_weight Drop Weight (integer)

Default value: 0

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

fill_in_new_order Fill In New Order (boolean)

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.

allow_partial_bundles Allow Partial Bundles (boolean)

Default value: true

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

required_item_id uuid

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

required_item_count Required Item Count (integer)

Default value: 0

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

stack_limit Stack Limit (integer)

Default value: 0

Amount of owned/rented of this Loot's item that will prevent this Loot from dropping in a randomly sampled vendor

quantity_type Quantity Type (string)

Possible values: [relative, absolute]

Determines how the quantity is to be modified.

Relative looks at the context in which is fulfilled; e.g. If Loot A has a quantity of 2 and 5 is being fulfill, the resulting quantity modification will be 10.

Absolute ignores the context in which it is fulfilled; e.g. If Loot B has a quantity of 3 and 5 is being fulfill 5, the resulting quantity modification will be 3.

quantity_multi_inventory_item_id uuid

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player's Inventory.

is_claimable_by_client Is Claimable By Client (boolean)

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.

legacy_time_frame_id Legacy Time Frame Id (integer)

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

time_frame_id uuid

The Time Frame ID. Optional Time Frame ID that will be used for the expiration of inventory records when Loot when it is fulfilled.

use_inventory_bucket Inventory Bucket (string)

Possible values: [free, sweat, none, anon, amazon, steam, psn, xbox_live, google, twitch, nintendo_switch, apple, nintendo, epic, google_play, nintendo_ppid]

Grouping of Inventory Items. Inventory items are grouped into different buckets as each Platform that is supported has different requirements on how Inventory can be used on their Platform and other Platforms.

xp_quantity_transform_type XP Quantity Transform (string)

Possible values: [none, from_current_xp_to_target_additional_level_min_xp, from_current_level_min_xp_to_target_additional_level_min_xp, from_zero_to_target_exact_level_min_xp]

Allows granting xp levels as Loot. If the player is already max level, the Loot will not be fulfilled. Requires the Item assigned to the Loot to have an XP Table ID.

The following examples assume the player is level 3 with 150 total xp. The quantity configured on the Loot being fulfilled is 1. The XP Table is configured like so: 1: 20 2: 50 3: 100 4: 200 5: 400

from_current_xp_to_target_additional_level_min_xp - The Loot will grant the player enough xp to reach min xp of the next level. Example 1: fulfill quantity 1 Player will be level 4 with 200 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 400 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 400 total xp.

from_current_level_min_xp_to_target_additional_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the next level from the min xp of the current level. Example 1: fulfill quantity 1 Player will be level 4 with 250 total xp. Example 2: fulfill quantity 2 Player will be level 5 with 450 total xp. Example 3: fulfill quantity 3 Player will be level 5 with 450 total xp.

from_zero_to_target_exact_level_min_xp - The Loot will grant the player the amount of xp required to reach the min xp of the target level from zero xp. Example 1: fulfill quantity 1 Player will be level 3 with 170 total xp. Example 2: fulfill quantity 2 Player will be level 4 with 200 total xp. Example 3: fulfill quantity 3 Player will be level 4 with 250 total xp.

current_price_point_id uuid

The current price point id. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

pre_sale_price_point_id uuid

The pre sale price point id. Optional Price Point ID that will be used to show the previous price of the Loot.

hard_quantity_maximum Hard Quantity Maximum (integer)

Default value: 0

Hard cap on quantity of an item this Loot can give. Disabled with 0

legacy_loot_id Legacy Loot Id (integer)

Default value: 0

The legacy ID of the Loot.

sandbox_id uuid

ID of the Sandbox

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

loot_id uuidrequired

The Loot ID

vendor_id uuidrequired

The Vendor ID

vendor_name Vendor Name (string)

Name corresponding Vendor ID

sub_vendor_name Sub Vendor Name (string)

Name corresponding Sub-Vendor ID

item_name Item Name (string)

Name corresponding Item ID

required_item_name Required Item Name (string)

Name corresponding Required Item ID

quantity_multi_inventory_item_name Quantity Multi Inventory Item Name (string)

Name corresponding Quantity Multi Inventory Item ID

current_price_point_name Current Price Point Name (string)

Name corresponding Current Price Point ID

pre_sale_price_point_name Pre Sale Price Point Name (string)

Name corresponding Pre-sale Price Point ID

]

Example (from schema)

{
  "items": [
    {
      "left": {
        "custom_data": {},
        "name": "string",
        "description": "string",
        "item_type": "unit",
        "entitled_loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "level_xp_table_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "level_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "inventory_bucket_use_rule_set_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "coupon_discount_percentage": 0,
        "coupon_consume_on_use": true,
        "coupon_discount_loot": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "coupon_discount_currency_item_name": "string",
        "coupon_discount_currency_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "total_ownership_max": 0,
        "legacy_item_id": 0,
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
        "created_timestamp": "2024-07-29T15:51:28.071Z",
        "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "entitled_loot_name": "string",
        "level_vendor_name": "string",
        "level_xp_table_name": "string",
        "inventory_bucket_use_rule_set_name": "string"
      },
      "right": {
        "custom_data": {},
        "name": "string",
        "description": "string",
        "item_type": "unit",
        "entitled_loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "level_xp_table_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "level_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "inventory_bucket_use_rule_set_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "coupon_discount_percentage": 0,
        "coupon_consume_on_use": true,
        "coupon_discount_loot": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "coupon_discount_currency_item_name": "string",
        "coupon_discount_currency_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "total_ownership_max": 0,
        "legacy_item_id": 0,
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
        "created_timestamp": "2024-07-29T15:51:28.071Z",
        "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "entitled_loot_name": "string",
        "level_vendor_name": "string",
        "level_xp_table_name": "string",
        "inventory_bucket_use_rule_set_name": "string"
      }
    }
  ],
  "vendors": [
    {
      "left": {
        "custom_data": {},
        "name": "string",
        "description": "string",
        "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
        "created_timestamp": "2024-07-29T15:51:28.071Z",
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "legacy_vendor_id": 0,
        "vendor_type": "recipe",
        "loot": [
          {
            "custom_data": {},
            "name": "string",
            "description": "string",
            "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "sub_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "quantity": 1,
            "inventory_selector_type": "own",
            "inventory_operation": "add",
            "active": false,
            "sort_order": 0,
            "drop_weight": 0,
            "fill_in_new_order": false,
            "allow_partial_bundles": true,
            "required_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "required_item_count": 0,
            "stack_limit": 0,
            "quantity_type": "relative",
            "quantity_multi_inventory_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "is_claimable_by_client": false,
            "legacy_time_frame_id": 0,
            "time_frame_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "use_inventory_bucket": "free",
            "xp_quantity_transform_type": "none",
            "current_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "pre_sale_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "hard_quantity_maximum": 0,
            "legacy_loot_id": 0,
            "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
            "created_timestamp": "2024-07-29T15:51:28.071Z",
            "loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "vendor_name": "string",
            "sub_vendor_name": "string",
            "item_name": "string",
            "required_item_name": "string",
            "quantity_multi_inventory_item_name": "string",
            "current_price_point_name": "string",
            "pre_sale_price_point_name": "string"
          }
        ]
      },
      "right": {
        "custom_data": {},
        "name": "string",
        "description": "string",
        "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
        "created_timestamp": "2024-07-29T15:51:28.071Z",
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "legacy_vendor_id": 0,
        "vendor_type": "recipe",
        "loot": [
          {
            "custom_data": {},
            "name": "string",
            "description": "string",
            "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "sub_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "quantity": 1,
            "inventory_selector_type": "own",
            "inventory_operation": "add",
            "active": false,
            "sort_order": 0,
            "drop_weight": 0,
            "fill_in_new_order": false,
            "allow_partial_bundles": true,
            "required_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "required_item_count": 0,
            "stack_limit": 0,
            "quantity_type": "relative",
            "quantity_multi_inventory_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "is_claimable_by_client": false,
            "legacy_time_frame_id": 0,
            "time_frame_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "use_inventory_bucket": "free",
            "xp_quantity_transform_type": "none",
            "current_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "pre_sale_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "hard_quantity_maximum": 0,
            "legacy_loot_id": 0,
            "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
            "created_timestamp": "2024-07-29T15:51:28.071Z",
            "loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "vendor_name": "string",
            "sub_vendor_name": "string",
            "item_name": "string",
            "required_item_name": "string",
            "quantity_multi_inventory_item_name": "string",
            "current_price_point_name": "string",
            "pre_sale_price_point_name": "string"
          }
        ]
      }
    }
  ],
  "loot": [
    {
      "left": {
        "custom_data": {},
        "name": "string",
        "description": "string",
        "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sub_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "quantity": 1,
        "inventory_selector_type": "own",
        "inventory_operation": "add",
        "active": false,
        "sort_order": 0,
        "drop_weight": 0,
        "fill_in_new_order": false,
        "allow_partial_bundles": true,
        "required_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "required_item_count": 0,
        "stack_limit": 0,
        "quantity_type": "relative",
        "quantity_multi_inventory_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "is_claimable_by_client": false,
        "legacy_time_frame_id": 0,
        "time_frame_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "use_inventory_bucket": "free",
        "xp_quantity_transform_type": "none",
        "current_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "pre_sale_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "hard_quantity_maximum": 0,
        "legacy_loot_id": 0,
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
        "created_timestamp": "2024-07-29T15:51:28.071Z",
        "loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "vendor_name": "string",
        "sub_vendor_name": "string",
        "item_name": "string",
        "required_item_name": "string",
        "quantity_multi_inventory_item_name": "string",
        "current_price_point_name": "string",
        "pre_sale_price_point_name": "string"
      },
      "right": {
        "custom_data": {},
        "name": "string",
        "description": "string",
        "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sub_vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "quantity": 1,
        "inventory_selector_type": "own",
        "inventory_operation": "add",
        "active": false,
        "sort_order": 0,
        "drop_weight": 0,
        "fill_in_new_order": false,
        "allow_partial_bundles": true,
        "required_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "required_item_count": 0,
        "stack_limit": 0,
        "quantity_type": "relative",
        "quantity_multi_inventory_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "is_claimable_by_client": false,
        "legacy_time_frame_id": 0,
        "time_frame_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "use_inventory_bucket": "free",
        "xp_quantity_transform_type": "none",
        "current_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "pre_sale_price_point_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "hard_quantity_maximum": 0,
        "legacy_loot_id": 0,
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
        "created_timestamp": "2024-07-29T15:51:28.071Z",
        "loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "vendor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "vendor_name": "string",
        "sub_vendor_name": "string",
        "item_name": "string",
        "required_item_name": "string",
        "quantity_multi_inventory_item_name": "string",
        "current_price_point_name": "string",
        "pre_sale_price_point_name": "string"
      }
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...