Skip to content
RallyHere Docs

Get Catalog Entitlement Sku

GET
/inventory/v1/catalog/entitlement-sku/{platform}/{sku}

Get a specific Entitlement SKU.

Authorizations

Parameters

Path Parameters

platform
required

An enumeration.

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

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

string

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

Responses

200

Successful Response

Platform SKU that can be converted to inventory or keys

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
platform
required

The platform of the SKU

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

The SKU of the platform

string
loot_entitlement

The Loot that will be granted to the player

object
type
required

The action taken on the platform when granting this SKU

string
Allowed values: consumable durable durable_single_use
loot_id
required

The Loot ID that will be granted to the player

integer
refund_loot_id

The Loot ID that will be granted to the player when the SKU is refunded

integer
chargeback_loot_id

The Loot ID that will be granted to the player when the SKU is charged back

integer
chargeback_reversal_loot_id

The Loot ID that will be granted to the player when the SKU is charged back is reversed

integer
external_key_entitlement

The External Key Entitlement

object
external_key_campaign_id
required

The External Key Campaign ID

string format: uuid
quantity
required

The quantity of the External Key Entitlement

integer
cache_info

Cache info for the Platform SKUs.

object
etag
required
string
>= 1 characters
str_rep
string

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

304

Content still has the same etag and has not changed

403

Forbidden

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

404

Not Found

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