쿠폰함 리스트 검색 API

소개

쿠폰함에 있는 복수의 쿠폰들의 정보를 조회합니다.

기본정보

GET /coupon/v3.0/{user_token_type}/couponbox/list
Host:
   https://api.onstove.com (LIVE)    
   https://api.gate8.com (SB)
Content-Type: application/json

Request

Header

Name	Type	Required	Default Value	Example	Description
Authorization	String	Y	-	{Access Token}	사용자의 인증을 통해 발급 되는 access token

Path Variable

Name	Type	Required	Default Value	Example	Description
user_token_type	string	Y	-	web	유저토큰종류 공통 - 모든 타입의 토큰 사용

Paramater (Query String)

Name	Type	Required	Default Value	Example	Description
game_code	string	Y	-	STOVE_ID	게임ID (플랫폼에서 부여)
start_date	Int64	Y	-	1514764800000	시작일시 (TIMESTAMP, UTC+0) 검색 기준 : 쿠폰 등록일
end_date	Int64	Y	-	1640998861000	종료일시 (TIMESTAMP, UTC+0)
use_state_code	Int32	N	0	1	쿠폰 상태
page_size	Int32	Y	-	10	페이지 사이즈
page_no	Int32	Y	-	1	페이지 번호
lang_code	String	N	-	ko	언어코드

Response

Body

Name	Type	Required	Default Value	Example	Description
result	String	Y	-	000	응답 코드
message	String	Y	-	OK	응답 메시지
value	Object	Y	-		응답 값

Value

Name	Type	Required	Default Value	Example	Description
total_count	Int32	Y	-	2	총 건수
list	Object Array	-	-	리스트 정보

list

Name	Type	Required	Default Value	Example	Description
coupon_box_id	Int64	Y	-	6449393	쿠폰박스 일련번호
game_code	String	Y	-	45	게임ID (플랫폼에서 부여)
coupon_name	String	Y	-	테스트쿠폰	쿠폰 명
reward_type_code	Int16 Array	Y	-	1,2	쿠폰 보상 코드
reward_type	String Array	Y	-	캐시,아이템	쿠폰 보상 타입
use_start_date	Int64	Y	0	1673404740000	쿠폰 사용 시작일 (TIMESTAMP, UTC+0)
use_end_date	Int64	Y	0	1706668740000	쿠폰 사용 만료일 (TIMESTAMP, UTC+0)
register_date	Int64	Y	0	1686668740000	쿠폰 등록일 (TIMESTAMP, UTC+0)
use_date	Int64	Y	0	1696668740000	쿠폰 사용일 (TIMESTAMP, UTC+0)
use_state	Int32	Y	-	4	쿠폰 사용 상태
deadline_state	Int32	Y	0	1	마감 상태 사용 마감(1)인 경우, 쿠폰함에 있더라도 사용하지 못함

Sample

Request

curl --location --request GET'https://api.onstove.com/coupon/v3.0/web/couponbox/list?start_date=1642467600000&end_date=1642640400000&lang_code=en&game_code=CAOA&use_state_code=0&page_size=10&page_no=1' \
--header 'Authorization: Bearer {{access_token}}'

Response

Content-Type : application/json

{
    "value": {
        "total_count": 5,
        "list": [
            {
                "coupon_box_id": 1,
                "game_code": "240",
                "coupon_name": "쿠폰이름A",
                "reward_type_code": [1],
                "reward_type": ["캐시"],
                "use_start_date": 1530421561000,
                "use_end_date": 1535778361000,
                "register_date": 1530521561000,
                "use_date": 0,
                "use_state": 2
            },
            {
                "coupon_box_id": 2,
                "game_code": "240",
                "coupon_name": "쿠폰이름B",
                "reward_type_code": [2],
                "reward_type": ["아이템"],
                "use_start_date": 1530421561000,
                "use_end_date": 1535778361000,
                "register_date": 1530521561000,
                "use_date": 0,
                "use_state": 1
            },
            {
                "coupon_box_id": 3,
                "game_code": "240",
                "coupon_name": "쿠폰이름C",
                "reward_type_code": [4],
                "reward_type": ["당첨권"],
                "use_start_date": 1530421561000,
                "use_end_date": 1535778361000,
                "register_date": 1530521561000,
                "use_date": 0,
                "use_state": 2
            },
            {
                "coupon_box_id": 4,
                "game_code": "240",
                "coupon_name": "쿠폰이름E",
                "reward_type_code": [8],
                "reward_type": ["랜덤아이템"],
                "use_start_date": 1530421561000,
                "use_end_date": 1532495161000,
                "register_date": 1532149561000,
                "use_date": 0,
                "use_state": 4
            },
            {
                "coupon_box_id": 5,
                "game_code": "240",
                "coupon_name": "쿠폰이름D",
                "reward_type_code": [16],
                "reward_type": ["게임포인트"],
                "use_start_date": 1530421561000,
                "use_end_date": 1532495161000,
                "register_date": 1532149561000,
                "use_date": 0,
                "use_state": 4
            },
            {
                "coupon_box_id": 6,
                "game_code": "240",
                "coupon_name": "쿠폰이름F",
                "reward_type_code": [32],
                "reward_type": ["보너스 스토브 캐시"],
                "use_start_date": 1530421561000,
                "use_end_date": 1532495161000,
                "register_date": 1532149561000,
                "use_date": 0,
                "use_state": 4
            },
            {
                "coupon_box_id": 7,
                "game_code": "240",
                "coupon_name": "쿠폰이름G",
                "reward_type_code": [64],
                "reward_type": ["할인"],
                "use_start_date": 1530421561000,
                "use_end_date": 1532495161000,
                "register_date": 1532149561000,
                "use_date": 0,
                "use_state": 4
            },
            {
                "coupon_box_id": 8,
                "game_code": "240",
                "coupon_name": "쿠폰이름H",
                "reward_type_code": [128],
                "reward_type": ["할인"],
                "use_start_date": 1530421561000,
                "use_end_date": 1532495161000,
                "register_date": 1532149561000,
                "use_date": 0,
                "use_state": 4
            }
        ]
    },
    "result": "000",
    "message": ""
}

응답 실패 예제

{
    "result": "999",
    "message": "unexpected error"
}

Return Code

HTTP Status code	Code	Message	Description
200	999	unexpected error	시스템오류
401	999		Authorization has been denied for this request