Get Player Inventory Self

GET 
/inventory/v1/player/me/inventory

deprecated

Get the Inventory for the currently authenticated player.

Request

Query Parameters

item_ids integer[]

Responses

200

Successful Response

application/json

Schema

Schema

inventory

object

Inventory Context for a Player.

items

object

Item Inventories for this Inventory.

property name*

ItemInventory

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

records

object

Inventory Records for this Item Inventory.

property name*

InventoryRecord

Inventory Record for a Player

inventory_id uuidrequired

Unique ID for this Inventory Record.

type InventoryType (string)required

Possible values: [persistent, transient, always_owned]

Type of Inventory Record.

legacy_inventory_id

int64

Legacy Inventory ID.

anyOf

MOD1

integer

bucket InventoryBucket (string)

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

Default value: none

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.

count Count (integer)required

Instance count for this Inventory Record.

acquired date-timerequired

When this Inventory Record was acquired.

expires

object

When this Inventory Record expires.

anyOf

Time Zone Aware Datetime

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

string

custom_data

object

Arbitrary map of data for this Inventory Record.

anyOf

MOD1

property name* string

cache_info

object

Cache Info for this Item Inventory.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

cache_info

object

Cache Info for this Inventory.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

Example (from schema)

{
  "inventory": {
    "items": {},
    "cache_info": {}
  }
}

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "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"
    }
  ]
}

503

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

Response Headers

• Retry-After

  integer

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

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

Loading...