Skip to content
RallyHere Docs
GitHub

Get Catalog Items All

GET
/inventory/v1/catalog/item

Get all Items.

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

string

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

Responses

200

Successful Response

A collections of Items by Item ID.

object
items

A collection of Items by Item ID

object
key
additional properties

An Item. Item come in a couple of different flavors; determined by the type field. Unit items are stored in a player’s inventory. Recipe items are not stored in a player’s inventory and are used to fulfill SubVendor Loot. RecipeWithPriceReduction items are not stored in a player’s inventory 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 inventory 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
type

The type of item.

string
Allowed values: unit recipe recipe_with_price_reduction entitlement dynamic_bundle
legacy_type
integer
legacy_subtype
integer
ref_item_id
integer
availability_flags
integer
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.

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

integer
level_vendor_id

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

integer
coupon_discount_currency_item_id

The item of the currency used by this coupon. This is only valid for an unit Item.

integer
coupon_discount_percentage

The percentage of the discount. This is only valid for an unit Item.

number
<= 1
coupon_consume_on_use

If true, the coupon will be consumed when used; reducing the Player’s Inventory quantity by 1. This is only valid for an unit Item.

boolean
item_portal_use_ruleset_id
integer
inventory_bucket_use_rule_set_id

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

string
coupon_discount_loot

List of Loot IDs this item can discount

Array<integer>
default:
cache_info

Cache information for this item.

object
etag
required
string
>= 1 characters
str_rep
string
cache_info

Item’s cache information.

object
etag
required
string
>= 1 characters
str_rep
string

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

304

Content still has the same etag and has not changed

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Not Found

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string