Skip to main content
POST
/
api
/
v1
/
products
상품 생성
curl --request POST \
  --url https://api.steppay.kr/api/v1/products \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "type": "SOFTWARE",
  "status": "SALE",
  "name": "유튜브 구독 상품",
  "productOrder": 0,
  "featuredImageUrl": "Url string",
  "imageUrls": [
    "Url string"
  ],
  "description": "유튜브 프리미엄",
  "summary": "string",
  "sku": "회",
  "quantity": null,
  "enabledDemo": true,
  "demoPeriod": 30,
  "demoPeriodUnit": "DAY",
  "useCombination": false,
  "optionCombinations": [],
  "categoryIds": [],
  "eventBadge": [
    {
      "event": "string",
      "startDateTime": "9999-01-01T00:00:00",
      "endDateTime": "9999-01-01T00:00:00"
    }
  ],
  "useWidget": {
    "useDemo": true,
    "useEventBadge": true,
    "useOnetimePurchasable": true,
    "useNotice": true
  }
}
'
{
  "id": 1,
  "code": "product_AbCdEfGhI",
  "type": "SOFTWARE",
  "status": "SALE",
  "name": "유튜브 구독 상품",
  "subTitle": null,
  "featuredImageUrl": "Url string",
  "imageUrls": [
    "Url string"
  ],
  "description": "유튜브 프리미엄",
  "summary": "string",
  "reasonOfReject": null,
  "sku": "회",
  "quantity": null,
  "combinedProducts": [],
  "optionGroups": [],
  "useCombination": false,
  "optionCombinations": [],
  "prices": [],
  "createdAt": "9999-01-01T00:00:00.000000",
  "modifiedAt": "9999-01-01T00:00:00.000000",
  "enabledDemo": true,
  "demoPeriod": 30,
  "demoPeriodUnit": "DAY",
  "categories": [],
  "vendorUuid": "206992bb-6462-4b4f-9847-cf2f40d55b48",
  "productOrder": 0,
  "isOnetimePurchasable": false,
  "eventBadge": [
    {
      "event": "string",
      "startDateTime": "9999-01-01T00:00:00",
      "endDateTime": "9999-01-01T00:00:00"
    }
  ],
  "notice": null,
  "useWidget": {
    "useDemo": false,
    "useEventBadge": false,
    "useOnetimePurchasable": false,
    "useNotice": false
  },
  "groupId": null,
  "countrySetting": null
}

Authorizations

​
Secret-Token
string
header
required

Body

application/json
​
type
enum<string>
required

상품 타입을 지정합니다.

Available options:
BOX,
SOFTWARE,
BUNDLE,
INVOICE,
DRAFT
​
status
enum<string>
required

상품 상태를 지정합니다.

Available options:
SALE,
OUT_OF_STOCK,
UNSOLD,
WAITING_APPROVAL,
REJECTED
​
name
string
required

상품 이름

​
productOrder
integer<int32>

순서

​
subTitle
string

부제목

​
featuredImageUrl
string

결제화면에서 나타는 상품 이미지 입니다.

​
imageUrls
string[]

상품 이미지 URL

상품 이미지 URL

​
description
string

상품 설명

​
summary
string

상품 요약

​
sku
string

SKU

​
quantity
integer<int32>

상품 수량 - null 로 지정하면 상품 구매시 수량이 감소되지 않습니다.

​
enabledDemo
boolean

체험 기간 사용 여부 (기본값: false)

​
demoPeriod
integer<int32>

체험 기간 (기본값: 7)

​
demoPeriodUnit
enum<string>

체험 기간 단위 (기본값: DAY)

Available options:
DAY,
WEEK,
MONTH,
YEAR
​
optionGroups
object[]

옵션 그룹 설정

​
useCombination
boolean

조합형 옵션 사용 여부 (기본값: true)

​
optionCombinations
object[]

옵션 조합

​
categoryIds
integer<int64>[]

카테고리

카테고리

​
eventBadge
object[]

이벤트 뱃지

​
notice
string

유의 사항

​
isOnetimePurchasable
boolean

활성 구독 제한 (기본값: false)

​
useWidget
object
​
countrySettingId
integer<int64>

결제 국가 설정 ID

​
availableRegions
enum<string>[]

판매 가능 국가(region)

판매 가능 국가(region)

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
US_ALABAMA,
US_ALASKA,
US_ARIZONA,
US_ARKANSAS,
US_CALIFORNIA,
US_COLORADO,
US_CONNECTICUT,
US_DELAWARE,
US_FLORIDA,
US_GEORGIA,
US_HAWAII,
US_IDAHO,
US_ILLINOIS,
US_INDIANA,
US_IOWA,
US_KANSAS,
US_KENTUCKY,
US_LOUISIANA,
US_MAINE,
US_MARYLAND,
US_MASSACHUSETTS,
US_MICHIGAN,
US_MINNESOTA,
US_MISSISSIPPI,
US_MISSOURI,
US_MONTANA,
US_NEBRASKA,
US_NEVADA,
US_NEW_HAMPSHIRE,
US_NEW_JERSEY,
US_NEW_MEXICO,
US_NEW_YORK,
US_NORTH_CAROLINA,
US_NORTH_DAKOTA,
US_OHIO,
US_OKLAHOMA,
US_OREGON,
US_PENNSYLVANIA,
US_RHODE_ISLAND,
US_SOUTH_CAROLINA,
US_SOUTH_DAKOTA,
US_TENNESSEE,
US_TEXAS,
US_UTAH,
US_VERMONT,
US_VIRGINIA,
US_WASHINGTON,
US_WEST_VIRGINIA,
US_WISCONSIN,
US_WYOMING,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
​
vendorUuid
string<uuid>

Response

정상적으로 생성됨

상품 정보

​
id
integer<int64>
required

상품 아이디

​
code
string
required

상품 코드

​
status
enum<string>
required

상품 상태

Available options:
SALE,
OUT_OF_STOCK,
UNSOLD,
WAITING_APPROVAL,
REJECTED
​
combinedProducts
번들 상품 정보 · object[]
required

번들 상품 정보

​
optionGroups
상품 옵션 그룹 정보 · object[]
required

옵션 그룹 정보

​
useCombination
boolean
required

조합형 옵션 사용 여부

​
optionCombinations
object[]
required

옵션 조합

​
prices
가격 플랜 정보 · object[]
required

가격 플랜 목록

​
createdAt
string<date-time>
required

생성 시점

​
enabledDemo
boolean
required

체험기간 활성화 여부

​
demoPeriod
integer<int32>
required

체험 기간

​
demoPeriodUnit
enum<string>
required

체험 기간 단위

Available options:
DAY,
WEEK,
MONTH,
YEAR
​
categories
object[]
required

카테고리

​
vendorUuid
string<uuid>
required

가맹점 UUID

​
productOrder
integer<int32>
required

순서

​
isOnetimePurchasable
boolean
required
deprecated

활성 구독 제한

​
eventBadge
첫 구매 할인 정보 · object[]
required
deprecated

이벤트 뱃지

​
type
enum<string>

상품 타입

Available options:
BOX,
SOFTWARE,
BUNDLE,
INVOICE,
DRAFT
​
name
string

상품 이름

​
subTitle
string

부제목

​
featuredImageUrl
string

상품 대표 이미지 URL

​
imageUrls
string[]

상품 이미지 URL

상품 이미지 URL

​
description
string

상품 설명

​
summary
string

상품 요약

​
reasonOfReject
string

상품 승인 거절 사유

​
sku
string
deprecated

SKU

​
quantity
integer<int32>

재고 수량

​
modifiedAt
string<date-time>

수정 시점

​
notice
string
deprecated

유의 사항

​
useWidget
object
deprecated

상품 위젯 사용 여부

​
groupId
integer<int64>
deprecated

그룹 ID

​
countrySetting
object

국가 설정 정보

​
availableRegions
판매국가 정보 · object[]

판매 가능 국가