Sign in
Players' Store Items

Get Player Store Items

Returns the store built for the player, the same way the Game Hub builds it.

Prices, discounts, bonuses and purchase limits are personalized: store promotions, segments, campaigns and the player's own purchase history are all applied, so the response is what the player would see on the Game Hub.

The store is priced with the country and the platform of the player, set by PUT /players/{player_id}, so the endpoint takes no pricing parameters. Order the offers it returns by passing their id as items[].store_item_id to POST /orders.

get/v1/players/{player_id}/store_items

Path parameters

player_idstring required

Response

Successful Response

idstring required

The unique identifier of the store item the offer comes from

item_idstring required

The unique identifier of the item the offer sells

skustring required

The SKU of the item

type'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency' | 'piggy_bank' required
namestring required

The name of the item

descriptionstring

The description of the item

background_image_colorstring

The color of the background image for the item

currency'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC' required
priceinteger

The price of the item in minor currency units

price_after_discountinteger

The price the player pays after all discounts are applied

discount_percentinteger

The discount percent applied to the item

is_free_itemboolean

Whether the item is given for free

quantityinteger

The base quantity of the item

quantity_after_bonusinteger

The quantity the player receives with the bonus

bonus_percentinteger

The bonus percent applied to the quantity

disabledboolean

Whether the item is not available for purchase or claim

max_purchasesinteger

How many times the item can be purchased

purchases_leftinteger

How many purchases the player has left

next_purchase_atnumber

When the item becomes purchasable again

expires_atinteger

When the offer for the item expires

Changes

Changed in 2 of the 28 revisions of this API.21

  • 1816e2044c072See the full diff
    • ●

      added the new piggy_bank enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new piggy_bank enum value to the / response property for the response status

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6d6269f8cab61See the full diff
    • ○

      endpoint added

      endpoint-added