1️⃣

1. Category List View

Retrieves the list of in-game store categories.

Basic Information

GET /bill-store/v1.0/{{service_id}}/product/categories
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

Paramater (Query String)

Name	Type	Required	Default Value	Example	Description
shop_key	String	Y	-	indie	In-game Shop key
category_parent_id	String	N	-	061A30EC8C904CA	Parent Category Key • If NULL, return all categories
category_depth	Int32	N	-	1	Category Depth • Top-level depth: 1

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
category_id	String	Y	-	061A30EC8C904CA	Category Key
category_parent_id	String	N	-	D55DD291CAAA459	Parent Category Key
category_display_no	Int32	Y	-	1	카테고리 순서
category_name	String	Y	-	카테고리A	Category Name • Multilingual Support
category_depth	Int32	Y	-	1	Category Depth

Sample

Request

curl --location --request GET'https://api.onstove.com/bill-store/v1.0/{{service_id}}/product/categories?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":{
      "total_count":2,
      "list":[
         {
            "category_id":"061A30EC8C904CA",
            "category_parent_id":null,		
            "category_display_no":"1",
            "category_name":"Category A",
			"category_depth": 1
         },
         {
            "category_id":"D55DD291CAAA459",
            "category_parent_id":"061A30EC8C904CA", 		
            "category_display_no":"1",
            "category_name":"Category A-A",
 			"category_depth": 1 
         }
      ]
   },
   "code":0,
   "message":"OK"
}
JavaScript
복사

Response Failure Example

{  "code": "999999",  "message": "An undefined error."}
JavaScript
복사

Return Code

HTTP Status code	response_code	response_message	Description
200	0	OK	Success
200	999999	An undefined error.	Item Shop API Error
500	500	Internal Server Error	Internal server error