Skip to content

Get Items

GET
/v1/sandbox/{sandbox_id}/item

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

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

item_ids

Item IDs to filter by

Array<string>

Item IDs to filter by

legacy_item_ids

Legacy Item IDs to filter by

Array<integer>

Legacy Item IDs to filter by

types

Item types to filter by

Array<string>
Allowed values: unit recipe recipe_with_price_reduction entitlement

Item types to filter by

coupon_currency_item_ids

Coupon Currency Item IDs to filter by

Array<string>

Coupon Currency Item IDs to filter by

inventory_bucket_use_rule_set_ids

Inventory Bucket Use Rule Set IDs to filter by

Array<string>

Inventory Bucket Use Rule Set IDs to filter by

level_xp_ids

Level Xp IDs to filter by

Array<string>

Level Xp IDs to filter by

name

Filter by case insensitive name

string
>= 1 characters <= 50 characters

Filter by case insensitive name

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: item_id legacy_item_id type coupon_currency_item_id coupon_discount_percentage inventory_bucket_use_rule_set_id level_xp_table_id level_vendor_id name description last_modified_timestamp last_modified_account_id

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 Items.

object
data

The Items.

Array<object>
default:

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

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_type

The type of item.

string
Allowed values: unit recipe recipe_with_price_reduction entitlement
entitled_loot_id

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.

string format: uuid
level_xp_table_id

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.

string format: uuid
level_vendor_id

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.

string format: uuid
inventory_bucket_use_rule_set_id

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

string format: uuid
coupon_discount_percentage

The amount the price is discounted. This is a percentage between 0 and 1. For example, 0.25 would be a 25% discount.

number
> 0 <= 1
coupon_consume_on_use

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.

boolean
coupon_discount_loot

List of Loot IDs this item can discount

Array<string>
default:
coupon_discount_currency_item_name

Name of corresponding currency Item ID

string
coupon_discount_currency_item_id

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

string format: uuid
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
item_id
required

The Item ID.

string format: uuid
legacy_item_id

The Legacy Item ID.

integer
entitled_loot_name

Name corresponding entitled Loot ID

string
level_vendor_name

Name of corresponding level Vendor ID

string
level_xp_table_name

Name of corresponding level XP Table ID

string
inventory_bucket_use_rule_set_name

Name of corresponding Inventory Bucket Use Rule Set 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