Get Entitlement Skus

GET

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

Get Entitlement Skus by filters. All filters must be true for an Entitlement Sku to be returned. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

• RallyHereHTTPBearer

Parameters

Path Parameters

sandbox_id

required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

entitlement_sku_ids

Entitlement Sku IDs to filter by

Array<string>

default:

Entitlement Sku IDs to filter by

loot_ids

Filter by Entitlement Sku with matching Loot IDs

Array<string>

default:

Filter by Entitlement Sku with matching Loot IDs

types

Filter by Entitlement Sku with matching Loot Entitlement types

Array<string>

default:

Allowed values: consumable durable durable_single_use

Filter by Entitlement Sku with matching Loot Entitlement types

external_key_campaign_ids

Filter by Entitlement Sku with matching External Key Campaign IDs

Array<string>

default:

Filter by Entitlement Sku with matching External Key Campaign IDs

platforms

Filter by Entitlement Sku with matching platforms

Array<string>

default:

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

Filter by Entitlement Sku with matching platforms

skus

Filter by Entitlement Sku with matching SKUs

Array<string>

default:

Filter by Entitlement Sku with matching SKUs

name

Filter by case insensitive name

string

>= 1 characters <= 50 characters

Filter by case insensitive name

last_modified_account_ids

Filter by last modified account ID

Array<string>

default:

Filter by last modified account ID

sort_by

Sort results by

string

Allowed values: entitlement_sku_id sku loot_id entitlement_type campaign_id name last_modified_timestamp last_modified_account_id

Sort results by

sort_order

Sort order

string

Allowed values: asc desc

Sort order

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string

default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

expand

Resources to expand and fill in additional detail

Array<string>

Allowed values: * legacy_id

Resources to expand and fill in additional detail

Responses

200

Successful Response

A collection of Entitlement Skus.

object

data

The Entitlement Skus.

Array<object>

default:

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

type

required

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

string

Allowed values: consumable durable durable_single_use

loot_id

required

The Loot ID granted when this SKU is received.

string format: uuid

refund_loot_id

The Loot ID granted when this SKU is refunded by the platform. Currently only supported on PSN

string format: uuid

chargeback_loot_id

The Loot ID granted when this SKU is charged back by the platform. Currently only supported on PSN

string format: uuid

chargeback_reversal_loot_id

The Loot ID granted when this SKU has a charged back reversed by the platform. Currently only supported on PSN

string format: uuid

loot_name

The Loot Name. Only included when Loot is expanded.

string

legacy_loot_id

The Legacy Loot ID granted when this SKU is received

integer

refund_loot_name

The Refund Loot Name. Only included when Loot is expanded

string

refund_legacy_loot_id

The Legacy Loot ID granted when this SKU is refunded by the platform. Currently only supported on PSN

integer

chargeback_loot_name

The Chargeback Loot Name. Only included when Loot is expanded

string

chargeback_legacy_loot_id

The Legacy Loot ID granted when this SKU is charged back by the platform. Currently only supported on PSN

integer

chargeback_reversal_loot_name

The Chargeback Reversal Loot Name. Only included when Loot is expanded

string

chargeback_reversal_legacy_loot_id

The Legacy Loot ID granted when this SKU has a charged back reversed by the platform. Currently only supported on PSN

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

page_meta

required

The paging metadata.

object

cursor

required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string

>= 1 characters <= 128 characters

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

total

The total number of entities.

integer

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string