STOVE Store Developer Guide alpha

# 쿠폰함 쿠폰 상세 내역 조회 API

# 소개

쿠폰함 쿠폰의 상세 내역을 조회합니다.

# 기본정보

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

# Request

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 (플랫폼에서 부여)
coupon_box_id Int64 Y - 10169 쿠폰박스 일련번호
lang_code String Y - ko 한국어:"ko", 영어:"en", 일본어:"ja", 중국어:"zh"

# Response

# Body

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

# Value

Name Type Required Default Value Example Description
coupon_type Int32 Y - 1 쿠폰 유형
coupon_name String(100) Y - 테스트쿠폰 쿠폰 명
coupon_notice String(2^31-1) N - 쿠폰 사용 시 주의사항 입니다. 쿠폰 주의 사항
coupon_no String(100) Y - 9255CUCC581TTB2P 쿠폰 번호
register_date Int64 Y - 1706668740000 등록일시 (timestamp, UTC +0)
use_date Int64 N 0 1806668740000 사용일시 (timestamp, UTC +0)
game_code String(45) Y - 45 게임ID (플랫폼에서 부여)
world_nos String(45) Array N - [1,2] 쿠폰 제한 정보 > 사용가능한 월드 정보
reward_infos Object Array Y - - 혜택정보
limits Object Array Y - - 제한 정보
(12:할인적용상품 만 추가됨)
use_start_date Int64 Y - 1574271081523 사용가능 시작일자 (timestamp, UTC +0)
use_end_date Int64 Y - 1574271081523 사용가능 종료일자 (timestamp , UTC +0)
use_state Int32 Y - 1 쿠폰 상태 코드
game_code String(45) Y - 45 게임ID (플랫폼에서 부여)
world_nos String(45) Array N - [1,2] 쿠폰 제한 정보 > 사용가능한 월드 정보
reward_infos Object Array Y -
혜택정보
limits Object Array Y -
제한 정보(12:할인적용상품 만 추가됨)
use_start_date Int64 Y - 1574271081523 사용가능 시작일자 (timestamp, UTC +0)
use_end_date Int64 Y - 1574271081523 사용가능 종료일자 (timestamp, UTC +0)
use_state Int32 Y - 1 쿠폰 상태 코드
reward_supplier Int16 Y 2 2 보상 공급처
reward_receiver Int16 Y 1 1 보상 받는자 기준
limit_login_country bool Y - false 해당 쿠폰을 사용가능한 접속국가인지 여부
valid_coupon_img_url String N - https://d2psesh1x3i95y.cloudfront.net/qa/application_no/10009/iop-billing-center/car1.png PC쿠폰함 사용가능 쿠폰 이미지 URL
invalid_coupon_img_url String N - https://d2psesh1x3i95y.cloudfront.net/qa/application_no/10009/iop-billing-center/배너11.png PC쿠폰함 사용완료/만료 쿠폰 이미지 URL
mobile_coupon_img_url String N - https://d2psesh1x3i95y.cloudfront.net/qa/application_no/10009/iop-billing-center/208_157.png MOBILE쿠폰함 사용완료/만료 이미지
coupon_box_id Int64 N 0 10169 쿠폰박스 일련번호

# limits

Name Type Required Default Value Example Description
limit_code Int32 Y - 1 제한분류코드
limit_value String(32) Y - [world1,world2] 제한값

# reward_infos

Name Type Required Default Value Example Description
reward_type Int32 Y - 2 쿠폰 보상 코드
reward_name String Y - 푸른 불꽃날개 30일 보상명
reward_value Double Y - 3 보상값
reward_additional_info Object N - 보상추가정보
현재 보상이 할인(128)인 경우만 전달

# reward_additional_info

Name Type Required Default Value Example Description
discount_type Int16 Y - 1 할인타입
discount_goods String Array Y - [1231,9023] 할인적용상품
MAX 100

# Sample

# Request

curl --location --request GET'http://api.onstove.com/coupon/v3.0/web/couponbox/list/4300407?lang_code=ko&game_code=CAOA' \
--header 'Authorization: Bearer {{access_token}}'
1
2

# Response

Content-Type : application/json

{
  "value": {
    "coupon_type": 1,
    "coupon_name": "테스트 쿠폰",
    "coupon_notice": "쿠폰 주의 사항",
    "coupon_no": "AB90A2B0PSF0CA50",
    "register_date": 1574271081523,
    "use_date": 1574271081523,
    "game_code": "290",
    "world_nos": [],
    "reward_infos": [
      {
        "reward_type": 2,
        "reward_name": "푸른 불꽃날개 30일",
        "reward_value": 3
      },
      {
        "reward_type": 32,
        "reward_name": "3000 CASH",
        "reward_value": 3000
      }
    ],
    "use_start_date": 1561939200000,
    "use_end_date": 1593586305000,
    "use_state": 2,
    "reward_supplier": 2,
    "reward_receiver": 1
  },
  "result": "000",
  "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

응답실패 예제

{
    "message": "invalid token",
    "code": 40101
}
1
2
3
4

# Return Code

HTTP Status code Code Message Description
200 999 unexpected error -
401 40100 no token 토큰이 없는 경우
401 40101 invalid token 토큰 복호화가 안되는 경우
401 40102 invalid token 복호화 했으나 포맷이 다른 경우
401 40103 expired token 토큰이 만료된 경우
401 40104 expired token 관리자의 무효처리에 의해 토큰이 만료된 경우
500 50000 internal error 장애 상황(DB 연결 불가 등)
200 그 외 내부 오류 내부오류: *STOVE 기술PM팀으로 문의 바랍니다.
Last Updated: 2023. 10. 20. 오후 1:35:09

← 통합 쿠폰함 쿠폰 사용 API →