Retrieve Entitlement Request For Me

GET 
/inventory/v2/player/me/entitlement/request/:request_id

Get the status of a platform entitlement request by request id.

Required Permissions:

• For any player (including themselves) any of: inv:*, inv:platform_entitlements:any

• For the player themselves : inv:platform_entitlements:self

Request

Path Parameters

request_id Request Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

request_id Request Id (string)required

unique id to allow tracking the request

client_type ClientType (string)required

Possible values: [UNKNOWN, WIN, MAC, XBOXONE, PS4, SWITCH, ANDROID, IOS, PS5, LINUX, XSX]

client type this purchase was made on

transaction_id Transaction Id (string)required

unique id for this transaction on the platform

platform_region PlatformRegion (string)required

Possible values: [Unknown, NA, EU]

region this purchase was made in

status Status (string)

Default value: SUBMITTED

status of this result

error_code

object

Error code for failures not associated with a specific entitlement

anyOf

MOD1

string

client_entitlements

object[]

Client entitlements that have been processed

Array [

platform_sku Platform Sku (string)required

platform identifier for this purchase type

platform_entitlement_id Platform Entitlement Id (string)required

unique identifier for this purchased item (instance owned by this user)

quantity Quantity (integer)

Default value: 1

number purchased

status EntitlementStatus (string)

Possible values: [UNKNOWN, SUBMITTED, FULFILLED, FAILED, PREVIOUSLY_APPLIED, SKIPPED]

Default value: UNKNOWN

status of this entitlement

error_code Error Code (string)

Default value: none

Error code for this entitlement

order_id Order Id (string)

Order ID for this entitlement

]

server_entitlements

object[]

Server entitlements that have been processed

Array [

platform_sku Platform Sku (string)required

platform identifier for this purchase type

platform_entitlement_id Platform Entitlement Id (string)required

unique identifier for this purchased item (instance owned by this user)

quantity Quantity (integer)

Default value: 1

number purchased

status EntitlementStatus (string)

Possible values: [UNKNOWN, SUBMITTED, FULFILLED, FAILED, PREVIOUSLY_APPLIED, SKIPPED]

Default value: UNKNOWN

status of this entitlement

error_code Error Code (string)

Default value: none

Error code for this entitlement

order_id Order Id (string)

Order ID for this entitlement

]

platform_id Platform (string)required

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

Platform these transactions were processed on

platform_user_id Platform User Id (string)required

Unique identifier for the platform user that processed this entitlement

skipped_server_entitlements Skipped Server Entitlements (boolean)

True if the server entitlements were skipped

Example (from schema)

{
  "request_id": "string",
  "client_type": "UNKNOWN",
  "transaction_id": "string",
  "platform_region": "Unknown",
  "status": "SUBMITTED",
  "error_code": "string",
  "client_entitlements": [
    {
      "platform_sku": "string",
      "platform_entitlement_id": "string",
      "quantity": 1,
      "status": "UNKNOWN",
      "error_code": "none",
      "order_id": "string"
    }
  ],
  "server_entitlements": [
    {
      "platform_sku": "string",
      "platform_entitlement_id": "string",
      "quantity": 1,
      "status": "UNKNOWN",
      "error_code": "none",
      "order_id": "string"
    }
  ],
  "platform_id": "Anon",
  "platform_user_id": "string",
  "skipped_server_entitlements": false
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

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

404

The specified player was not found

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