Skip to content
RallyHere Docs

Process Platform Entitlement For Me

POST
/inventory/v2/player/me/entitlement

Process platform entitlements, consuming from the platform inventory where possible and generating orders.

Note that some orders may not be fulfilled at the completion of this request and need to be polled separately for results

Required Permissions:

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

  • For the player themselves : inv:platform_entitlements:self

Authorizations

Request Body required

Request to process a platform entitlement

object
transaction_id
required

Unique id for this transaction on the platform

string
platform_token
required

Platform token that can be used to verify the identity of the user

string
platform_id
required

Platform this entitlement was purchased was made on

string
platform_region
required

Region this purchase was made in

string
Allowed values: Unknown NA EU
client_type
required

Client type this purchase was made on

string
Allowed values: UNKNOWN WIN MAC XBOXONE PS4 SWITCH ANDROID IOS PS5 LINUX XSX
entitlements

Platform entitlements to process

Array<object>
default:

Entitlement for a platform. This takes in a sku and platform entitlement id and checks to see if the user has the entitlement on the platform

object
platform_sku
required

Platform identifier for this purchase type

string
platform_entitlement_id
required

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

string
quantity

Number purchased

integer
default: 1
status

Status of this entitlement

string
Allowed values: UNKNOWN SUBMITTED FULFILLED FAILED PREVIOUSLY_APPLIED
error_code

Error code for this entitlement

string
Allowed values: none auth_token_failure missing_information failed_to_consume no_sku_found wrong_sku_type_provided durable_authority_type_not_valid durable_single_use_authority_type_not_valid consumable_authority_type_not_valid unknown_sku_type_provided failed_to_submit_order already_applied_durable_single_use quantity_zero previously_applied
order_id

Order ID for this entitlement

string

Responses

200

Successful Response

Result of processing a platform entitlement

object
request_id
required

Unique id to allow tracking the request

string
client_type
required

Client type this purchase was made on

string
Allowed values: UNKNOWN WIN MAC XBOXONE PS4 SWITCH ANDROID IOS PS5 LINUX XSX
transaction_id
required

Unique id for this transaction on the platform

string
platform_region
required

Region this purchase was made in

string
Allowed values: Unknown NA EU
status

Status of this result

string
default: SUBMITTED
error_code

Error code for failures not associated with a specific entitlement

string
client_entitlements

Client entitlements that have been processed

Array<object>
default:

Entitlement for a platform. This takes in a sku and platform entitlement id and checks to see if the user has the entitlement on the platform

object
platform_sku
required

Platform identifier for this purchase type

string
platform_entitlement_id
required

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

string
quantity

Number purchased

integer
default: 1
status

Status of this entitlement

string
Allowed values: UNKNOWN SUBMITTED FULFILLED FAILED PREVIOUSLY_APPLIED
error_code

Error code for this entitlement

string
Allowed values: none auth_token_failure missing_information failed_to_consume no_sku_found wrong_sku_type_provided durable_authority_type_not_valid durable_single_use_authority_type_not_valid consumable_authority_type_not_valid unknown_sku_type_provided failed_to_submit_order already_applied_durable_single_use quantity_zero previously_applied
order_id

Order ID for this entitlement

string
server_entitlements

Server entitlements that have been processed

Array<object>
default:

Entitlement for a platform. This takes in a sku and platform entitlement id and checks to see if the user has the entitlement on the platform

object
platform_sku
required

Platform identifier for this purchase type

string
platform_entitlement_id
required

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

string
quantity

Number purchased

integer
default: 1
status

Status of this entitlement

string
Allowed values: UNKNOWN SUBMITTED FULFILLED FAILED PREVIOUSLY_APPLIED
error_code

Error code for this entitlement

string
Allowed values: none auth_token_failure missing_information failed_to_consume no_sku_found wrong_sku_type_provided durable_authority_type_not_valid durable_single_use_authority_type_not_valid consumable_authority_type_not_valid unknown_sku_type_provided failed_to_submit_order already_applied_durable_single_use quantity_zero previously_applied
order_id

Order ID for this entitlement

string
platform_id
required

Platform these transactions were processed on

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

Unique identifier for the platform user that processed this entitlement

string
skipped_server_entitlements

True if the server entitlements were skipped

boolean

403

Forbidden

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