Create New Inventory Session

POST 
/inventory/v1/player/:player_id/session

deprecated

Create a new Inventory Session for the specified player.

Request

Path Parameters

player_id Player Idrequired

application/json

Body

required

session_platform

object

The platform for the session.

anyOf

Platform

string

Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

Responses

202

Successful Response

application/json

Schema

Schema

session_id Session Id (string)required

The ID of the session.

session_platform

object

The platform for the session.

anyOf

Platform

string

Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

order_id

object

The ID of the Order generated for any Loot given during the creation of the Inventory Session.

anyOf

MOD1

string

Example (from schema)

{
  "session_id": "string",
  "session_platform": "Anon",
  "order_id": "string"
}

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"
    }
  ]
}

Loading...