Skip to content

Get Entitlement Sku By Id

GET
/v1/sandbox/{sandbox_id}/entitlement-sku/{entitlement_sku_id}

Get Entitlement Sku by ID. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

entitlement_sku_id
required

Entitlement Sku ID

string format: uuid

Entitlement Sku ID

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Responses

200

Successful Response

Represents the mapping of an External SKU to a Loot or Key Campaign. Type is only used for

object
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
platform
required

The platform the Entitlement Sku is for.

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch
loot_entitlement

The Loot Entitlement.

object
loot_id
required

The Loot ID.

string format: uuid
type
required

Determine how the entitlement is handled on the Platform’s side.

string
Allowed values: consumable durable durable_single_use
loot_name

The Loot Name. Only included when Loot is expanded.

string
legacy_loot_id

The Legacy Loot ID.

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 keys to grant to the player.

integer
> 0
external_key_campaign_name

The External Key Campaign Name. Only included when External Key Campaign is expanded.

string
sku
required

The External SKU.

string
>= 1 characters <= 256 characters
sandbox_id

ID of the Sandbox

string format: uuid
entitlement_sku_id
required

The Entitlement Sku ID.

string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string