Generate Entitlement Event

POST 
/inventory/v1/entitlement-event

Create an entitlement event - this is used to bypass platform providers and grant entitlement events directly.

Required Permissions:

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

Request

application/json

Body

required

action_type EntitlementActionType (string)required

Possible values: [grant, refund, chargeback, chargeback_reversal]

The type of the event

status

object

The status of the event

anyOf

EntitlementEventStatus

string

Possible values: [success, sku_not_found, not_implemented, player_not_found, ban_failed]

player_uuid

object

Override the player UUID for the event. If not provided, the active player for the platform user will be used

anyOf

MOD1

string

platform Platform (string)required

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

The platform for the event

platform_user_id Platform User Id (string)required

Possible values: <= 2048 characters

The platform user ID for the event

sku Sku (string)required

Possible values: <= 2048 characters

The SKU for the event

quantity Quantity (integer)

Default value: 1

The quantity for the event

platform_transaction_id Platform Transaction Id (string)required

Possible values: <= 4096 characters

The external transaction ID for the event

platform_data

object

The platform specific data for the event

anyOf

MOD1

object

Responses

200

Successful Response

application/json

Schema

Schema

event_id Event Id (string)required

The unique identifier for the event

action_type EntitlementActionType (string)required

Possible values: [grant, refund, chargeback, chargeback_reversal]

The type of the event

entitlement_type

object

The type of entitlement when the event occurred

anyOf

EntitlementType

The method of granting a Platform Entitlement SKU

string

Possible values: [consumable, durable, durable_single_use]

status EntitlementEventStatus (string)required

Possible values: [success, sku_not_found, not_implemented, player_not_found, ban_failed]

The status of the event

player_uuid

object

required

The player UUID for the event

anyOf

MOD1

string

player_id

object

deprecated

The player ID for the event

anyOf

MOD1

integer

platform Platform (string)required

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

The platform for the event

platform_user_id Platform User Id (string)required

Possible values: <= 2048 characters

The platform user ID for the event

sku Sku (string)required

Possible values: <= 2048 characters

The SKU for the event

quantity Quantity (integer)required

The quantity for the event

platform_transaction_id

object

The external transaction ID for the event

anyOf

MOD1

string

Possible values: <= 4096 characters

platform_data

object

The platform specific data for the event

anyOf

MOD1

object

order_id

object

The order ID for the event

anyOf

MOD1

string

loot_id

object

The loot ID for the event

anyOf

MOD1

integer

key_claim_uuid

object

The portal user key claim id

anyOf

MOD1

string

created date-timerequired

The timestamp for the event

last_modified date-timerequired

The timestamp for the event

Example (from schema)

{
  "event_id": "string",
  "action_type": "grant",
  "entitlement_type": "consumable",
  "status": "success",
  "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "platform": "Anon",
  "platform_user_id": "string",
  "sku": "string",
  "quantity": 0,
  "platform_transaction_id": "string",
  "platform_data": {},
  "order_id": "string",
  "loot_id": 0,
  "key_claim_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2023-01-23T21:07:02.000000+00:00",
  "last_modified": "2023-01-23T21:07:02.000000+00:00"
}

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

Error Codes:

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

409

Error Codes:

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