Skip to main content
GET
/
api
/
v1
/
products
/
{code}
상품 상세 조회
curl --request GET \
  --url https://api.steppay.kr/api/v1/products/{code} \
  --header 'Secret-Token: <api-key>'
{
  "id": 1,
  "code": "product_AbCdEfGhI",
  "type": "SOFTWARE",
  "status": "SALE",
  "name": "Product Name",
  "subTitle": null,
  "featuredImageUrl": "Url string",
  "imageUrls": [
    "Url string"
  ],
  "description": "Product Description",
  "summary": "string",
  "reasonOfReject": null,
  "sku": "unit",
  "quantity": 0,
  "combinedProducts": [],
  "optionGroups": [
    {
      "id": 1,
      "name": "Option Group Name",
      "options": [
        {
          "id": 1,
          "name": "Basic",
          "quantity": 0,
          "price": 1000,
          "parent": null
        },
        {
          "id": 1,
          "name": "Standard",
          "quantity": 0,
          "price": 2000,
          "parent": null
        },
        {
          "id": 1,
          "name": "Pro",
          "quantity": 0,
          "price": 2000,
          "parent": null
        }
      ],
      "depth": null
    }
  ],
  "useCombination": false,
  "optionCombinations": [],
  "prices": [],
  "createdAt": "9999-01-01T00:00:00",
  "modifiedAt": "9999-01-01T00:00:00",
  "enabledDemo": true,
  "demoPeriod": 3,
  "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": "notice",
  "useWidget": {
    "useDemo": false,
    "useEventBadge": false,
    "useOnetimePurchasable": false,
    "useNotice": false
  },
  "groupId": null,
  "countrySetting": null
}

Authorizations

Secret-Token
string
header
required

Path Parameters

code
string
required

상품 코드

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

부제목

상품 대표 이미지 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[]

판매 가능 국가