Get Catalog Entitlement Sku All

GET 
/inventory/v1/catalog/entitlement-sku

Get all Entitlement SKUs.

Request

Header Parameters

if-none-match any

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

Response Headers

• ETag

  string

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

application/json

Schema

Schema

skus

object[]

A collection of SKUs

Array [

custom_data

object

Custom data associated with the resource

property name* string

platform Platform (string)required

Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

The platform of the SKU

sku Sku (string)required

The SKU of the platform

loot_entitlement

object

The Loot that will be granted to the player

anyOf

LootEntitlement

How a Platform SKU will be converted into Loot for a player

type EntitlementType (string)required

Possible values: [consumable, durable, durable_single_use]

The action taken on the platform when granting this SKU

loot_id Loot Id (integer)required

The Loot ID that will be granted to the player

refund_loot_id

object

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

anyOf

MOD1

integer

chargeback_loot_id

object

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

anyOf

MOD1

integer

chargeback_reversal_loot_id

object

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

anyOf

MOD1

integer

external_key_entitlement

object

The External Key Entitlement

anyOf

ExternalKeyEntitlement

external_key_campaign_id uuidrequired

The External Key Campaign ID

quantity Quantity (integer)required

The quantity of the External Key Entitlement

cache_info

object

Cache info for the Platform SKUs.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

]

cache_info

object

Cache info for the Platform SKUs.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

Example (from schema)

{
  "skus": [
    {
      "custom_data": {},
      "platform": "Anon",
      "sku": "string",
      "loot_entitlement": {},
      "external_key_entitlement": {},
      "cache_info": {}
    }
  ],
  "cache_info": {}
}

304

Content still has the same etag and has not changed

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...