Get Loot

GET

/v1/sandbox/{sandbox_id}/loot

Get Loot by filters. All filters must be true for a Loot to be returned. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

• RallyHereHTTPBearer

Parameters

Path Parameters

sandbox_id

required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

loot_ids

Loot IDs to filter by

Array<string>

Loot IDs to filter by

legacy_loot_ids

Legacy Loot IDs to filter by

Array<integer>

Legacy Loot IDs to filter by

vendor_ids

Vendor IDs to filter by

Array<string>

Vendor IDs to filter by

inventory_selector_types

Inventory Selector types to filter by

Array<string>

Allowed values: own rent rent_timeframe_locked own_transient inherit_entitlement_inventory

Inventory Selector types to filter by

inventory_operations

Inventory Selector types to filter by

Array<string>

Allowed values: add subtract set check_greater_than_or_equal check_less_than check_greater_than_or_equal_and_subtract

Inventory Selector types to filter by

name

Filter by case insensitive name

string

>= 1 characters <= 50 characters

Filter by case insensitive name

item_ids

Item IDs to filter by

Array<string>

Item IDs to filter by

sub_vendor_ids

Sub Vendor IDs to filter by

Array<string>

Sub Vendor IDs to filter by

current_price_point_ids

Price Point IDs to filter by

Array<string>

Price Point IDs to filter by

pre_sale_price_point_ids

Price Point IDs to filter by

Array<string>

Price Point IDs to filter by

active

Filter by active status

boolean

Filter by active status

expand

Resources to expand and fill in additional detail

Array<string>

Allowed values: * legacy_id

Resources to expand and fill in additional detail

last_modified_account_ids

Filter by last modified account ID

Array<string>

Filter by last modified account ID

sort_by

Sort results by

string

Allowed values: loot_id legacy_loot_id vendor_id sub_vendor_id item_id name description inventory_selector inventory_operation quantity active sort_order drop_weight fill_in_new_order allow_partial_bundles required_item_count stack_limit quantity_type is_claimable_by_client xp_quantity_transform_type use_inventory_bucket hard_quantity_maximum last_modified_timestamp

Sort results by

sort_order

Sort order

string

Allowed values: asc desc

Sort order

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string

default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

Responses

200

Successful Response

A collection of Loot.

object

data

The Loot.

Array<object>

default:

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

Custom data associated with the resource

object

key

additional properties

string

name

Name of the resource

string

>= 1 characters <= 125 characters

description

Description of the resource

string

>= 1 characters <= 250 characters

item_id

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

string format: uuid

sub_vendor_id

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

string format: uuid

quantity

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.

integer

default: 1

inventory_selector_type

required

The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.

string

Allowed values: own rent rent_timeframe_locked own_transient inherit_entitlement_inventory

inventory_operation

required

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.

string

Allowed values: add subtract set check_greater_than_or_equal check_less_than check_greater_than_or_equal_and_subtract

active

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

boolean

sort_order

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.

integer

drop_weight

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

integer

fill_in_new_order

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.

boolean

allow_partial_bundles

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

boolean

default: true

required_item_id

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

string format: uuid

required_item_count

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

integer

stack_limit

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

integer

quantity_type

Determines how the quantity is modified in the context it is fulfilled in.

string

Allowed values: relative absolute

quantity_multi_inventory_item_id

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

string format: uuid

is_claimable_by_client

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.

boolean

legacy_time_frame_id

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

integer

time_frame_id

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

string format: uuid

use_inventory_bucket

Inventory Bucket to use for this Loot.

string

Allowed values: free sweat none anon amazon steam psn xbox_live google twitch nintendo_switch apple nintendo epic google_play nintendo_ppid

xp_quantity_transform_type

Allows treating quantity as additional levels to grant to the Player.

string

Allowed 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

current_price_point_id

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

string format: uuid

pre_sale_price_point_id

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

string format: uuid

hard_quantity_maximum

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

integer

sandbox_id

ID of the Sandbox

string format: uuid

last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid

last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time

created_timestamp

Timestamp of when the resource was created

string format: date-time

loot_id

required

The Loot ID

string format: uuid

vendor_id

required

The Vendor ID

string format: uuid

legacy_loot_id

The legacy ID of the Loot.

integer

vendor_name

Name corresponding Vendor ID

string

sub_vendor_name

Name corresponding Sub-Vendor ID

string

item_name

Name corresponding Item ID

string

required_item_name

Name corresponding Required Item ID

string

quantity_multi_inventory_item_name

Name corresponding Quantity Multi Inventory Item ID

string

current_price_point_name

Name corresponding Current Price Point ID

string

pre_sale_price_point_name

Name corresponding Pre-sale Price Point ID

string

page_meta

required

The paging metadata.

object

cursor

required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string

>= 1 characters <= 128 characters

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

total

The total number of entities.

integer

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string