Skip to content
RallyHere Docs

Get Player Inventory

Deprecated
GET
/inventory/v1/player/{player_id}/inventory

Get the Inventory for the specified player.

Authorizations

Parameters

Path Parameters

player_id
required
integer

Query Parameters

item_ids
Array<integer>
default:

Responses

200

Successful Response

Inventory Context for a Player.

object
inventory

Inventory Context for a Player.

object
items

Item Inventories for this Inventory.

object
key
additional properties

Inventory of a particular Item for a Player organized by Inventory ID.

object
records

Inventory Records for this Item Inventory.

object
key
additional properties

Inventory Record for a Player

object
inventory_id
required

Unique ID for this Inventory Record.

string format: uuid
type
required

Type of Inventory Record.

string
Allowed values: persistent transient always_owned
legacy_inventory_id

Legacy Inventory ID.

integer format: int64
bucket

Bucket for this Inventory Record.

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

Instance count for this Inventory Record.

integer
acquired
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
expires

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
custom_data

Arbitrary map of data for this Inventory Record.

object
key
additional properties
string
cache_info

Cache Info for this Item Inventory.

object
etag
required
string
>= 1 characters
str_rep
string
cache_info

Cache Info for this Inventory.

object
etag
required
string
>= 1 characters
str_rep
string

403

Forbidden

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

503

Service was unable to fulfill the request at this time and should be retried after the Retry-After wait time

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

Headers

Retry-After
integer

Number of seconds after which to retry the request, when the server should have the resource available