Info Value
Updated on 18 September 2018
Response format JSON
HTTP Methods GET
Response object Item
API Version 1.0

Currency/Item/Get

Retrieve a single virtual currency item according to its ID or code.

Parameters

For this request either item_id or item_code is required. Both are not needed.

Parameter Type Description
item_id integer The ID of the item being requested
item_code string The code of the item being requested

Response

Element Type Description
item_id integer The ID of the item
game_id integer The game ID of the item
item_category_id integer The category ID of the item
item_type_id integer The ID of the item's type (e.g. consumable or non-consumable)
item_code string The code of the item
item_category_code string The code of the category
item_name string The item name
item_description string The item description
item_attributes string A JSON-encoded string of the item's attributes
child_item_count integer The number of child items
child_items array An array of child items for the item
Indexed by item_id with key in the format item_##
See Child Item Object*
prices array An array of available prices for the item, with the most relevant returned first
Indexed by price id with key in the format item_price_##
See Price Object
promotions array An array of current promotions for the item
Indexed by price id with key in the format item_price_##
See Promotion Object
max_allowed integer The maximum number of the item that can exist in a user's inventory
available_individually boolean Whether or not the item can be obtained individually
enabled boolean Whether or not the item is enabled
display_order integer The order in which the item should be displayed

Child Item Object

Element Type Description
item_id integer The ID of the child item
item_category_id integer The category ID of the item
item_type_id integer The ID of the item's type (e.g. consumable or non-consumable)
item_code string The code of the item
item_category_code string The code of the category
item_name string The item name
item_description string The item description
item_attributes string A JSON-encoded string of the item's attributes
max_allowed integer The maximum number of the item that can exist in a user's inventory
available_individually boolean Whether or not the item can be obtained individually
quantity integer How many of the child item are included with the parent item
display_order integer The order in which the item should be displayed

Price Object

Element Type Description
item_price_id integer The ID of the price
currency_id integer The ID of the currency purchasing with
currency_code string The code of the currency purchasing with
price integer, float The price itself
display_symbol_after boolean Whether or not the currency symbol is displayed after the price
html_symbol string The HTML version of the currency symbol purchasing with
unicode_symbol string The unicode version of the currency symbol purchasing with
is_promotion boolean Whether or not this price is a promotion
starts_at datetime The date/time in UTC of when this price started
expires_at datetime The date/time in UTC of when this price will finish

Promotion Object

Element Type Description
item_price_id integer The ID of the price
original_price_id integer The ID of the original price, the price that will the game will fall back to once the promotion has ended

Example

Request

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Currency/Item/Get&item_id=##

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Currency/Item/Get&item_code=##

Sample response

{
	"item_id" : 123,
	"game_id" : 1234,
	"item_category_id" : 0,
	"item_type_id" : 1,
	"item_code" : "TEST_ITEM",
	"item_category_code" : null,
	"item_name" : "Test Item",
	"item_description" : "Test Item Description",
	"item_attributes" : null,
	"child_item_count" : 0,
	"child_items" : {

	},
	"prices" : {
		"item_price_123" : {
			"item_price_id" : 123,
			"currency_id" : 1,
			"currency_code" : "TC",
			"price" : 20000.00,
			"display_symbol_after" : false,
			"html_symbol" : "$",
			"unicode_symbol" : "$",
			"is_promotion" : false,
			"starts_at" : "2013-08-07 10:58:36",
			"expires_at" : null
		},
		...
	},
	"promotions" : {
		"item_price_123" : {
			"item_price_id" : 123,
			"original_price_id" : 987
		}
	},
	"max_allowed" : 1,
	"available_individually" : true,
	"enabled" : true,
	"display_order" : 0
}