2-1. Item Details Inquiry

View the item's detailed information.

Basic Information

GET /bill-store/v1.0/{{service_id}}/product/{product_id}
Host:
 https://api.onstove.com (LIVE) 
 https://api.gate8.com (SB)
Content-Type: application/json
JavaScript
복사

Request

Header

Name	Type	Required	Default Value	Example	Description
authorization	String	N	-	{access_token}	Access token issued through user authentication ※ On the web, the "SUAT cookie value" is used
X-Lang	String	Y	-	ko	Language code
X-Nation	String	Y	-	KR	Country code
X-Timezone	String	Y	-	Asia/Seoul	Timezone
X-Utc-Offset	Int32	Y	-	540	UTC Offset
caller-id	String	Y	-	clientapp	API Caller Information Example: ServiceName_GAME_SERVER

Path Variable

Name	Type	Required	Default Value	Example	Description
service_id	String	Y	-	GAME_ID	Game ID issued by the studio
product_id	String	Y	-	1001	Platform-specific item ID - Passed as a parameter when viewing item details

Paramater (Query String)

Name	Type	Required	Default Value	Example	Description
shop_key	String	Y	-	indie	In-game shop key
pguid	String	N	-	-	When authenticating using the SUAT cookie value for Authorization, do not use it.
character_no	String	N	-	-	(Unused)
world_id	String	N	-	AAA	(Unused)
guid	Int64	N	-	123456	If a GUID is available, enter the GUID. If not, enter the member_no.

Response

Body

Name	Type	Required	Default Value	Example	Description
code	Integer	Y	-	0	Response code
message	String	Y	-	OK	Response message
value	Object	N	-		Response value

Value

Name	Type	Required	Default Value	Example	Description
total_count	Int	Y	-	10	Total count
list	Object	Y	-		List

List

Name	Type	Required	Default Value	Example	Description
product_id	Int64	Y	-	1001	Platform-specific item ID
inservice_item_id	String	Y	-	gameid	In-game item ID
product_name	String	Y	-	아이템A	Product Name • Multilingual Support
product_desc	String	Y	-	아이템A 입니다.	Product Description • Multilingual Support
quantity	Int32	Y	-	1	Quantity per item
product_type_code	Int16	N	-	1	Item Type Code • 1: Indie Package Game Item • 2: In-Game Item • 3: Package Item
category_id	String	N	-	1	Category ID
category_name	String	N	-	카테고리	Category Name
currency_code	String	Y	-	KRW	Country code
price	Decimal	Y	-	1000	Product List Price (Checkout)
display_price	Decimal	Y	-	1000	List Price (Display) • Currently not in use
str_display_price	String	Y	-	1000	STRING_Product List Price (Display) • Currently not in use
sale_price	Decimal	Y	-	500	Product Sales Price (Payment)
display_sale_price	Decimal	Y	-	500	Product Selling Price (Display) • Currently not in use
str_display_sale_price	String	Y	-	500	STRING_Product Selling Price (Display) • Currently not in use
discount_flag	bool	N	-	true	Whether a discount is available
discount_type	Int16	N	-	10	Discount Type • 1. Fixed Percentage • 2. Fixed Amount
discount_type_value	int32	N	-	10	Discounted price
discount_start_dt	Int64	N	-	1525219200000	Discount Start Date (timestamp)
discount_end_dt	Int64	N	-	1625219200000	Discount end date (timestamp)
total_quantity	Int32	Y	-	1	Total product sales quantity
member_quantity	Int32	N	-	1	Member Purchase Quantity • Purchase quantity per logged-in account
guid_quantity	Int32	N	-	1	Guided Purchase Quantity • Unique purchase quantity per game account
thumbnail_url	String	Y	-	https://	Featured Product Image
withdraw_flag	bool	Y	-	true	Possibility of Withdrawing Subscription
purchased_flag	bool	Y	-	true	Purchase Status • true: If there is at least one purchase history
badge_info	List<json objet>	N	-	-	Badge Information
purchase_limit_type_code	Int16	Y	-	1	Sales Restriction Types • 1. Unlimited • 2: Per Member
purchase_limit_cnt	Int32	N	-	1	Sales Limit Quantity • When purchase_limit_type_code:2, the limit quantity per member
sale_limit_cnt	Int32	Y	-	0	Total sales limit quantity
character_limit_cnt	Int32	N	-	1	Character-specific quantity limits
world_limit_cnt	Int32	N	-	1	World-specific quantity limit
sales_start_dt	Int64	N	-	1525219200000	Sales Start Date (timestamp) • If the sales period is ongoing, return null (SDK: 0)
sales_end_dt	Int64	N	-	1525219200000	Sales Start Date (timestamp) • If the sales period is ongoing, return null (SDK: 0)

badge_info

Name	Type	Required	Default Value	Example	Description
badge_name	String	Y	-	Hot Sale	Badge Name
badge_image_url	String	Y	-	https://	Mattie Image URL

Sample

Request

curl --location --request GET'https://api.onstove.com/bill-store/v1.0/{{service_id}}/product/{{product_id}}?
shop_key=indie' \
--header 'Authorization: Bearer {{access_token}}'
--header 'X-Lang: ko'
--header 'X-Nation: KR'
--header 'X-Timezone: Asia/Seoul'
--header 'X-Utc-Offset: 540'
--header 'caller-id: {{caller-id}}'
JavaScript
복사

Response

Content-Type : application/json

{
	 "value": {
		 "product_id": 1001,
		 "inservice_item_id": "gameidA",
		 "product_name": "A",
		 "product_desc": "A .",
		 "quantity": 1,
		 "product_type_code": 1,
		 "category_id": "7CD8D80B1267466",
		 "category_name": "",
		 "currency_code": "KRW",
		 "price": 1000,
		 "display_price": 1000,
		 "str_display_price": "1000",
		 "sale_price": 500,
		 "display_sale_price": 500,
		 "str_display_sale_price": 500,
		 "discount_flag": true,
		 "discount_type": 1,
		 "discount_type_value": 50,
		 "discount_start_dt": 1525219200000,
		 "discount_end_dt": 1625219200000,
		 "total_quantity": 1,
		 "member_quantity": 1,
		 "guid_quantity": 1,
		 "thumbnail_url": "https://",
		 "withdraw_flag": false,
		 "purchased_flag": true,
		 "product_desc_info": [
			 {
				 "property_type": "product_desc_01",
				 "property_value": " 1"
			 },
			 {
				 "property_type": "product_desc_02",
				 "property_value": " 2"
			 }
		 ],
		 "sales_start_dt": 1525219200000,
		 "sales_end_dt": 1625219200000
	 },
	 "code": 0,
	 "message": "OK"
}
JavaScript
복사

Response Failure Example

{
  "code": "999999",
  "message": " "
}
JavaScript
복사

Return Code

HTTP Status code	response_code	response_message	Description
200	0	OK	Success
	50001	The store does not exist or is currently undergoing maintenance.	Item Shop API Error
	50002	The product does not exist or is unavailable for sale.	Item Shop API Error
200	999999	This is an undefined error.	Item Shop API Error
500	500	Internal Server Error	Internal server error