Skip to content
RallyHere Docs

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

Authorizations

Request Body required

object
action_type
required

The type of the event

string
Allowed values: grant refund chargeback chargeback_reversal
status

The status of the event

string
Allowed values: success sku_not_found not_implemented player_not_found
player_uuid

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

string format: uuid
platform
required

The platform for the event

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
platform_user_id
required

The platform user ID for the event

string
<= 2048 characters
sku
required

The SKU for the event

string
<= 2048 characters
quantity

The quantity for the event

integer
default: 1
platform_transaction_id
required

The external transaction ID for the event

string
<= 4096 characters
platform_data

The platform specific data for the event

object

Responses

200

Successful Response

object
event_id
required

The unique identifier for the event

string
action_type
required

The type of the event

string
Allowed values: grant refund chargeback chargeback_reversal
entitlement_type

The type of entitlement when the event occurred

string
Allowed values: consumable durable durable_single_use
status
required

The status of the event

string
Allowed values: success sku_not_found not_implemented player_not_found
player_uuid
required

The player UUID for the event

string format: uuid
player_id

The player ID for the event

integer
platform
required

The platform for the event

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
platform_user_id
required

The platform user ID for the event

string
<= 2048 characters
sku
required

The SKU for the event

string
<= 2048 characters
quantity
required

The quantity for the event

integer
platform_transaction_id

The external transaction ID for the event

string
<= 4096 characters
platform_data

The platform specific data for the event

object
order_id

The order ID for the event

string
loot_id

The loot ID for the event

integer
key_claim_uuid

The portal user key claim id

string format: uuid
created
required

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

string format: date-time
last_modified
required

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

string format: date-time

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
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Error Codes:

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

409

Error Codes:

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