Skip to main content
POST
/
api
/
v1
/
cover
/
product
상품 정보 등록 API
curl --request POST \
  --url https://api.steppay.kr/api/v1/cover/product \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "partnerProductId": "<string>",
  "featuredImageUrl": "<string>",
  "replaceIfExists": true
}
'
{
  "id": 123,
  "name": "<string>",
  "partnerProductId": "<string>",
  "featuredImageUrl": "<string>"
}

Authorizations

Secret-Token
string
header
required

Body

application/json

상품 생성 데이터

name
string
required

상품 이름

partnerProductId
string
required

가맹점에서 사용하는 상품의 unique ID

상품 대표 이미지 URL

replaceIfExists
boolean

partnerProductId 이미 존재할 때 replaceIfExists가 true 이면 값을 수정하고, false 이면 exception 이 발생합니다.

Response

상품 정보가 정상적으로 등록됨

id
integer<int64>
required

상품 ID - 다른 API 호출에 사용되므로 해당 상품 정보와 함께 저장해놓고 사용하세요.

name
string
required

상품 이름

partnerProductId
string
required

가맹점에서 사용하는 상품의 unique ID

상품 대표 이미지 URL