Get Catalog All

GET

/inventory/v1/catalog

Get the entire catalog.

This endpoint endpoint is generally discouraged outside of prototyping and early development. It’s not that the endpoint won’t function, but rather that it creates a pattern that may result in a poor end user experience. It has etag/if-none-match handling, but it is for the entire catalog. So if a single byte changes inside the catalog (e.g. turning on a loot record, adding a single new item, changing a price point, adjusting the threshold to hit level X in an XP Table), then the etag will change. If clients are re-requesting data from this endpoint, then those changes will result in them re-downloading, and re-parsing the entire catalog for that tiny modification.

Early on in a game’s lifecycle, this doesn’t matter much - since catalog data is pretty small. But as your game grows, and you create lots of things to receive/purchase/grant, the data will balloon in size. Parsing the response does occur on unreal’s main thread, and with a sufficiently large catalog, you may see hitches. There will also be lots of data in there that may not even be necessary for your client to see at all (e.g. if you only grant the loot from the dedicated server or if an item is just a tracker, it doesn’t necessarily need to be visible on the client).

We generally encourage having a well-known list of vendors to request from /inventory/v1/catalog/vendor/{vendor_id}, and then requesting the entire set of xp tables, price points, and bucket rulesets (as those are generally pretty small lists). That list of vendors could come from anywhere, it could be hardcoded, be set from an ini (if your client is unlikely to need arbitrary vendor additions, but you want to retain the ability to patch it) or it could come down in a kv.

Authorizations

• HTTPBearerHeadersOrCookie

Parameters

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

Full list of all loaded objects for the catalog. Organized in a normalized model

object

xp_tables

The XP Tables.

object

xp_tables

object

key

additional properties

A collection of XP Levels from 1 to N. Each level has a minimum XP value.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

xp_uuid

The XP Table UUID

string format: uuid

xp_entries

object

key

additional properties

integer

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

portal_use_rulesets

The Portal Use Rulesets. Use Inventory Bucket Use Rule Sets instead.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

rulesets

object

key

additional properties

A collection of Portal Use Rules.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

rules

object

key

additional properties

Array<integer>

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

inventory_bucket_use_rule_sets

The rules on how to use Inventory Buckets.

object

rule_sets

object

key

additional properties

A collection of Inventory Bucket Use Rules.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

rules

object

key

additional properties

Array<string>

Allowed values: free sweat none anon amazon steam psn xbox_live google twitch nintendo_switch apple nintendo epic google_play nintendo_ppid

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

vendors

The Vendors.

object

vendors

object

key

additional properties

A collection of Loot and how to fulfill them.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

vendor_uuid

The Vendor UUID

string format: uuid

type

Determines how the Vendor fulfills the loot

string

Allowed values: recipe randomly_sampled

legacy_type

integer

legacy_config_version

integer

loot

The Loot the Vendor will fulfill mapped by Loot ID.

object

key

additional properties

Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

loot_uuid

The Loot UUID

string format: uuid

loot_id

required

The Loot ID

integer

vendor_id

required

The Vendor ID

integer

vendor_uuid

The Vendor UUID

string format: uuid

item_id

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

integer

item_uuid

The Item UUID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

string format: uuid

item

In-line Item definition. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

item_uuid

The Item UUID

string format: uuid

type

The type of item.

string

Allowed values: unit recipe recipe_with_price_reduction entitlement dynamic_bundle

legacy_type

integer

legacy_subtype

integer

ref_item_id

integer

availability_flags

integer

entitled_loot_uuid

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot that will be fulfilled.

string format: uuid

entitled_loot_id

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot ID that will be fulfilled.

integer

level_xp_table_uuid

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

string format: uuid

level_xp_table_id

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

integer

level_vendor_uuid

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

string format: uuid

level_vendor_id

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

integer

coupon_discount_currency_item_uuid

The item of the currency used by this coupon. This is only valid for an unit Item.

integer

coupon_discount_currency_item_id

The item of the currency used by this coupon. This is only valid for an unit Item.

integer

coupon_discount_percentage

The percentage of the discount. This is only valid for an unit Item.

number

<= 1

coupon_consume_on_use

If true, the coupon will be consumed when used; reducing the Player’s Inventory quantity by 1. This is only valid for an unit Item.

boolean

item_portal_use_ruleset_id

integer

inventory_bucket_use_rule_set_id

The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.

string

coupon_discount_loot

List of Loot IDs this item can discount

Array<integer>

default:

coupon_discount_loot_uuid

List of Loot this item can discount

Array<string>

default:

cache_info

Cache information for this item.

object

etag

required

string

>= 1 characters

str_rep

string

sub_vendor_id

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

integer

sub_vendor_uuid

The Sub Vendor UUID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

string format: uuid

quantity

The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.

integer

inventory_selector_type

The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.

string

Allowed values: invalid own rent rent_timeframe_locked own_transient inherit_entitlement_inventory

inventory_operation

The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.

string

Allowed values: invalid add subtract set check_greater_than_or_equal check_less_than check_greater_than_or_equal_and_subtract

active

Determines if the Loot is active. Inactive Loot will not be fulfilled.

boolean

sort_order

The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.

integer

drop_weight

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

integer

fill_in_new_order

When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.

boolean

allow_partial_bundles

When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player

boolean

default: true

required_item_id

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

integer

required_item_uuid

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

string format: uuid

required_item_count

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

integer

stack_limit

Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor

integer

ui_hint

integer

effective_from

string format: date-time

quantity_type

Determines how the quantity is modified in the context it is fulfilled in.

string

Allowed values: relative absolute

quantity_mult_inventory_item_id

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.

integer

quantity_mult_inventory_item_uuid

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.

string format: uuid

is_claimable_by_client

Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.

boolean

time_frame_id

The Time Frame ID. Optional Time Frame ID that will be used the expiration of Loot when it is fulfilled.

integer

use_inventory_bucket

Inventory Bucket to use for this Loot.

string

Allowed values: free sweat none anon amazon steam psn xbox_live google twitch nintendo_switch apple nintendo epic google_play nintendo_ppid

xp_quantity_transform_type

Allows treating quantity as additional levels to grant to the Player.

string

Allowed values: none from_current_xp_to_target_additional_level_min_xp from_current_level_min_xp_to_target_additional_level_min_xp from_zero_to_target_exact_level_min_xp

current_price_point_guid

The current price point guid. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

string

>= 1 characters

pre_sale_price_point_guid

The pre sale price point guid. Optional Price Point ID that will be used to show the previous price of the Loot.

string

>= 1 characters

cache_info

Cache info for the Loot.

object

etag

required

string

>= 1 characters

str_rep

string

hard_quantity_maximum

Hard cap on quantity of an item this Loot can give. Disabled with 0

integer

price

Current price that this loot can be purchased with

object

breakpoints

Breakpoints that the loot is available for purchase with

Array<object>

default:

Price Breakpoint for a specific quantity of units to purchase.

object

quantity

Amount of units that must be purchased to use this price

integer

default: 1

prices

List of all possible prices that this breakpoint can be purchased with.

Array<object>

default:

Single price that the loot can be purchased with. Note that all currencies of this list will be spent together.

object

currencies

All required currencies to use this price for purchase. All currencies in this list are spent together.

Array<object>

default:

One currency (of potentially multiple) that can be used for a purchase, and how much of that currency is required for the purchase.

object

price_item_id

required

The Item used as the currency for the purchase.

string format: uuid

price_legacy_item_id

The Item used as the currency for the purchase.

integer

current_price

required

The current amount of the item needed to use this price currency

integer

original_price

The amount of the item needed before the sale began

integer

strict_flag

Does the number of units being purchased need to be an exact match to the quantity on a Price Breakpoint?

boolean

cap_flag

Can the number of units being purchased be higher than the highest quantity on the Price Breakpoints?

boolean

cache_info

Cache info for the Vendor.

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

loot

The Loots.

object

loot

object

key

additional properties

Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

loot_uuid

The Loot UUID

string format: uuid

loot_id

required

The Loot ID

integer

vendor_id

required

The Vendor ID

integer

vendor_uuid

The Vendor UUID

string format: uuid

item_id

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

integer

item_uuid

The Item UUID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

string format: uuid

item

In-line Item definition. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

item_uuid

The Item UUID

string format: uuid

type

The type of item.

string

Allowed values: unit recipe recipe_with_price_reduction entitlement dynamic_bundle

legacy_type

integer

legacy_subtype

integer

ref_item_id

integer

availability_flags

integer

entitled_loot_uuid

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot that will be fulfilled.

string format: uuid

entitled_loot_id

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot ID that will be fulfilled.

integer

level_xp_table_uuid

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

string format: uuid

level_xp_table_id

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

integer

level_vendor_uuid

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

string format: uuid

level_vendor_id

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

integer

coupon_discount_currency_item_uuid

The item of the currency used by this coupon. This is only valid for an unit Item.

integer

coupon_discount_currency_item_id

The item of the currency used by this coupon. This is only valid for an unit Item.

integer

coupon_discount_percentage

The percentage of the discount. This is only valid for an unit Item.

number

<= 1

coupon_consume_on_use

If true, the coupon will be consumed when used; reducing the Player’s Inventory quantity by 1. This is only valid for an unit Item.

boolean

item_portal_use_ruleset_id

integer

inventory_bucket_use_rule_set_id

The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.

string

coupon_discount_loot

List of Loot IDs this item can discount

Array<integer>

default:

coupon_discount_loot_uuid

List of Loot this item can discount

Array<string>

default:

cache_info

Cache information for this item.

object

etag

required

string

>= 1 characters

str_rep

string

sub_vendor_id

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

integer

sub_vendor_uuid

The Sub Vendor UUID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

string format: uuid

quantity

The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.

integer

inventory_selector_type

The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.

string

Allowed values: invalid own rent rent_timeframe_locked own_transient inherit_entitlement_inventory

inventory_operation

The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.

string

Allowed values: invalid add subtract set check_greater_than_or_equal check_less_than check_greater_than_or_equal_and_subtract

active

Determines if the Loot is active. Inactive Loot will not be fulfilled.

boolean

sort_order

The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.

integer

drop_weight

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

integer

fill_in_new_order

When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.

boolean

allow_partial_bundles

When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player

boolean

default: true

required_item_id

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

integer

required_item_uuid

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

string format: uuid

required_item_count

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

integer

stack_limit

Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor

integer

ui_hint

integer

effective_from

string format: date-time

quantity_type

Determines how the quantity is modified in the context it is fulfilled in.

string

Allowed values: relative absolute

quantity_mult_inventory_item_id

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.

integer

quantity_mult_inventory_item_uuid

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.

string format: uuid

is_claimable_by_client

Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.

boolean

time_frame_id

The Time Frame ID. Optional Time Frame ID that will be used the expiration of Loot when it is fulfilled.

integer

use_inventory_bucket

Inventory Bucket to use for this Loot.

string

Allowed values: free sweat none anon amazon steam psn xbox_live google twitch nintendo_switch apple nintendo epic google_play nintendo_ppid

xp_quantity_transform_type

Allows treating quantity as additional levels to grant to the Player.

string

Allowed values: none from_current_xp_to_target_additional_level_min_xp from_current_level_min_xp_to_target_additional_level_min_xp from_zero_to_target_exact_level_min_xp

current_price_point_guid

The current price point guid. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

string

>= 1 characters

pre_sale_price_point_guid

The pre sale price point guid. Optional Price Point ID that will be used to show the previous price of the Loot.

string

>= 1 characters

cache_info

Cache info for the Loot.

object

etag

required

string

>= 1 characters

str_rep

string

hard_quantity_maximum

Hard cap on quantity of an item this Loot can give. Disabled with 0

integer

price

Current price that this loot can be purchased with

object

breakpoints

Breakpoints that the loot is available for purchase with

Array<object>

default:

Price Breakpoint for a specific quantity of units to purchase.

object

quantity

Amount of units that must be purchased to use this price

integer

default: 1

prices

List of all possible prices that this breakpoint can be purchased with.

Array<object>

default:

Single price that the loot can be purchased with. Note that all currencies of this list will be spent together.

object

currencies

All required currencies to use this price for purchase. All currencies in this list are spent together.

Array<object>

default:

One currency (of potentially multiple) that can be used for a purchase, and how much of that currency is required for the purchase.

object

price_item_id

required

The Item used as the currency for the purchase.

string format: uuid

price_legacy_item_id

The Item used as the currency for the purchase.

integer

current_price

required

The current amount of the item needed to use this price currency

integer

original_price

The amount of the item needed before the sale began

integer

strict_flag

Does the number of units being purchased need to be an exact match to the quantity on a Price Breakpoint?

boolean

cap_flag

Can the number of units being purchased be higher than the highest quantity on the Price Breakpoints?

boolean

cache_info

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

object

etag

required

string

>= 1 characters

str_rep

string

items

The Items.

object

items

A collection of Items by Item ID

object

key

additional properties

An Item. Item come in a couple of different flavors; determined by the type field. Unit items are stored in a player’s inventory. Recipe items are not stored in a player’s inventory and are used to fulfill SubVendor Loot. RecipeWithPriceReduction items are not stored in a player’s inventory and are used to fulfill SubVendor Loot but at a reduced cost if the Player owns some of the Loot. Entitlement items are stored in a player’s inventory and are fulfilled to the player each time an Inventory Session is created and when the Entitlement is fulfilled to the Player.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

item_uuid

The Item UUID

string format: uuid

type

The type of item.

string

Allowed values: unit recipe recipe_with_price_reduction entitlement dynamic_bundle

legacy_type

integer

legacy_subtype

integer

ref_item_id

integer

availability_flags

integer

entitled_loot_uuid

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot that will be fulfilled.

string format: uuid

entitled_loot_id

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot ID that will be fulfilled.

integer

level_xp_table_uuid

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

string format: uuid

level_xp_table_id

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

integer

level_vendor_uuid

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

string format: uuid

level_vendor_id

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

integer

coupon_discount_currency_item_uuid

The item of the currency used by this coupon. This is only valid for an unit Item.

integer

coupon_discount_currency_item_id

The item of the currency used by this coupon. This is only valid for an unit Item.

integer

coupon_discount_percentage

The percentage of the discount. This is only valid for an unit Item.

number

<= 1

coupon_consume_on_use

If true, the coupon will be consumed when used; reducing the Player’s Inventory quantity by 1. This is only valid for an unit Item.

boolean

item_portal_use_ruleset_id

integer

inventory_bucket_use_rule_set_id

The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.

string

coupon_discount_loot

List of Loot IDs this item can discount

Array<integer>

default:

coupon_discount_loot_uuid

List of Loot this item can discount

Array<string>

default:

cache_info

Cache information for this item.

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

Item’s cache information.

object

etag

required

string

>= 1 characters

str_rep

string

price_points

The Price Points.

object

price_points

Price Points mapped by Price Point ID.

object

key

additional properties

A collection of Price Breakpoints (volume pricing).

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

name

The name of the Price Point.

string

strict_flag

Forces the quantity to be equal to a quantity on a Price Breakpoint.

boolean

cap_flag

Only allows quantity to be fulfilled up the highest quantity on the Price Breakpoints

boolean

current_breakpoints

Current Price Breakpoints.

Array<object>

default:

Price based on quantity and the Item ID of the currency used.

object

price_item_uuid

The Item used as the currency for the purchase.

string format: uuid

price_item_id

Deprecated. Use the currencies field instead.

integer

quantity

required

integer

price

Deprecated. Use the currencies field instead.

integer

currencies

List of currencies for this break point

Array<object>

The currencies of a Price Breakpoint.

object

price_item_uuid

required

The Item used as the currency for the purchase.

string format: uuid

price_item_id

required

The Item used as the currency for the purchase.

integer

price

required

The price of the Item.

integer

pre_sale_breakpoints

Previous Price Breakpoints.

Array<object>

default:

Price based on quantity and the Item ID of the currency used.

object

price_item_uuid

The Item used as the currency for the purchase.

string format: uuid

price_item_id

Deprecated. Use the currencies field instead.

integer

quantity

required

integer

price

Deprecated. Use the currencies field instead.

integer

currencies

List of currencies for this break point

Array<object>

The currencies of a Price Breakpoint.

object

price_item_uuid

required

The Item used as the currency for the purchase.

string format: uuid

price_item_id

required

The Item used as the currency for the purchase.

integer

price

required

The price of the Item.

integer

cache_info

Cache info for the Price Point.

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

Cache info for the Price Points.

object

etag

required

string

>= 1 characters

str_rep

string

time_frames

The Time Frames.

object

time_frames

Time Frames mapped by Time Frame ID.

object

key

additional properties

Time Frames are used to calculate the expiration of Inventory

object

name

The name of the Time Frame.

string

active

Whether or not the Time Frame is active.

boolean

episode

integer

episode_type

integer

hour_interval

Number of hours that this time frame lasts until restarting.0 interval means no repeating.

integer

start

required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

end

required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

cache_info

Cache info for the Time Frame.

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

Cache info for the Time Frames.

object

etag

required

string

>= 1 characters

str_rep

string

skus

The Platform SKUs.

object

skus

A collection of SKUs

Array<object>

default:

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

cache_info

Cache info for the Platform SKUs.

object

etag

required

string

>= 1 characters

str_rep

string

cache_info

Cache info for the Catalog.

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