Skip to main content

Get Catalog Entitlement Sku By Platform

GET 
/inventory/v1/catalog/entitlement-sku/:platform

Get all Entitlement SKUs for a specific platform

Request​

Path Parameters

    platform Platformrequired

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

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​

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.

Schema

    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

    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

    integer

    chargeback_loot_id

    object

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

    anyOf

    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

    integer

    external_key_entitlement

    object

    The External Key Entitlement

    anyOf

    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

    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

Loading...