Sign in

v2

latestOpenAPI 3.1.02026-08-07168434918.5 KB
Items

Bulk Update Items

Updates multiple items.

patch/v1/items

Request body

namestring

The name of the item

descriptionstring nullable

The description of the item

priceinteger

The price of the item in minor currency units

price_pointinteger

The price point for local prices DEPRECATED

price_template_idstring

The ID of the price template

reward_points_priceinteger

The reward points price for local prices

discount_percentinteger

The discount percent for the item

bonus_percentinteger

The bonus percent 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'
skustring

The SKU of the item

image_url_applestring uri

The Apple-specific URL of the image for the item

icon_url_applestring uri

The Apple-specific URL of the icon for the item

image_url_featured_applestring uri

The Apple-specific URL of the image for the item in the featured card

background_image_colorstring

The color of the background image for the item

background_image_url_applestring uri

The Apple-specific URL of the background image for the item

featured_card_background_image_url_applestring uri

The Apple-specific URL of the featured card background image for the item

type'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency'
view_option'default' | 'skeleton'
quantityinteger

The quantity of the item

is_stackableboolean

Whether the item is stackable

is_currencyboolean

Whether the item is a currency.

archived_atnumber

The timestamp of when the item was archived

positioninteger

Position of the item in list

categoriesstring[]

The list of category IDs

durationinteger

Item's in-game action in seconds

enable_reward_points_redemptionboolean

Allows using Reward Points on purchase

commentstring

Internal comment for this item

is_systemboolean nullable

If true, this item will be skipped when sending webhooks

metaobject nullable
fallback_item_idstring

The item that will be given as fallback if the main item can't be given to the player

fallback_item_quantityinteger

The quantity of the fallback item

rarity_idstring

The rarity id of the item

idstring required

The unique identifier of the item

Response

Successful Response

namestring required

The name of the item

descriptionstring nullable

The description of the item

priceinteger

The price of the item in minor currency units. The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use price_template_id instead.

price_pointinteger

The price point for local prices DEPRECATED

price_template_idstring

The ID of the price template

reward_points_priceinteger

The reward points price for local prices

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
skustring required

The SKU of the item

image_url_applestring uri

The Apple-specific URL of the image for the item

icon_url_applestring uri

The Apple-specific URL of the icon for the item

image_url_featured_applestring uri

The Apple-specific URL of the image for the item in the featured card

background_image_url_applestring uri

The Apple-specific URL of the background image for the item

background_image_colorstring

The color of the background image for the item

featured_card_background_image_url_applestring uri

The Apple-specific URL of the featured card background image for the item

type'item' | 'currency' | 'bundle' | 'lootbox' | 'subscription' | 'virtual_currency' required
view_option'default' | 'skeleton'
quantityinteger

The quantity of the item

is_stackableboolean required

Whether the item is stackable

is_currencyboolean required

Whether the item is a currency.

positioninteger

Position of the item in list

categoriesstring[]

The list of category IDs

durationinteger

Item's in-game action in seconds

enable_reward_points_redemptionboolean

Allows using Reward Points on purchase

idstring required

The unique identifier of the item

source'order' | 'bonus' | 'bundle' | 'coupon' | 'lootbox' | 'free_item' | 'liveops' | 'daily_reward' | 'loyalty_reward' | 'progression_program' | 'rolling_offer' | 'pick_one_offer'
rarity_idstring

The rarity id of the item

discount_percentinteger

The discount percent for the item

bonus_percentinteger

The bonus percent for the item

is_customboolean
created_atnumber required

The timestamp of when the item was created

modified_atnumber

The timestamp of when the item was modified

archived_atnumber

The timestamp of when the item was archived

price_minor_unitinteger
price_decimalnumber
fallback_item_idstring

The item that will be given as fallback if the main item can't be given to the player

fallback_item_quantityinteger

The quantity of the fallback item

metaobject
model_type'ItemRead'
commentstring

Internal comment for this item

is_systemboolean nullable

If true, this item will be skipped when sending webhooks