추가상품 관리 API에서 사용합니다.
| 키 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| items | Array<AdditionalProductItem> | 필수 | 추가상품 목록 |
| orderType | AdditionalProductSortType | 선택 | 추가상품 정렬 기준 |
- 추가상품의 items 필드는 필수값입니다. 추가상품이 없는 경우에는 items 를 빈 배열로 전송해 주세요.
- 상품상세 페이지 내 추가상품값의 노출순서는 orderType 필드(AdditionalProductSortType)로 설정할 수 있으며, 값을 지정하지 않으면 기본값인 '등록순'이 적용됩니다.
수정 시 주의사항
상품 또는 추가상품 수정 요청 시, 일부 정보(추가상품값 텍스트/재고수량/추가상품가 등)만 변경하는 경우에도
추가상품 전체 목록 데이터를 모두 전송해야하며, 기 등록한 추가상품의 id값을 포함해야 합니다. 기 등록한 추가상품명 하위에 일부 추가상품값을 추가/삭제하거나, 추가상품명 구분을 새로 추가해야하는 경우에도
추가상품 전체 목록을 다시 등록해 주세요. * 요청에 포함되지 않은 기 등록 추가상품은 삭제됩니다.
* items 를 빈 배열로 전송하면 해당 상품의 추가상품이 모두 삭제됩니다. * usable 을 false 로 설정하는 것은 미노출 처리이며, 추가상품이 삭제되지는 않습니다.
AdditionalProductItem
- 추가상품은 추가상품명(name)과 추가상품값(value)의 조합으로 구성됩니다.
- 추가상품명 : 상품의 종류 (예시 : 가방)
- 추가상품값 : 추가상품명 하위 선택값 (예시 : 블랙, 화이트 등)
- 추가상품명·추가상품값이 동일한 항목은 중복 등록할 수 없습니다.
- 추가상품 재고수량은 본상품 재고수량과 별도로 관리됩니다. 추가상품을 설정하더라도 본상품 재고수량은 기존과 동일하게 입력해 주세요.
- 조회 응답의 items 배열은 추가상품명 → 추가상품 id 오름차순으로 정렬되어 반환됩니다. orderType 은 구매자에게 노출되는 순서 기준이며, 응답 배열의 순서와는 무관합니다.
필드 제약사항
# 문자열 길이제한
- 추가상품명은 최대 25자, 추가상품값은 최대 40자까지 입력 가능 합니다.
- 판매자 관리코드는 최대 20자까지 입력 가능합니다.
# 추가상품가
- 추가상품가는 최소 100원 이상 최대 1억 미만까지 10원 단위로 입력할 수 있습니다.
# 추가상품 재고수량
- 추가상품값 개별 재고수량 및 상품당 전체 추가상품의 재고수량은 최소 0개 이상 최대 1억개 미만으로
설정 가능 합니다.
- 재고수량을 0개로 설정 시 해당 추가상품은 '품절' 상태로 노출됩니다.
# 추가상품 등록 개수 제한
- 상품당 추가상품명은 최대 5개, 추가상품값 기준으로 전체 최대 500개까지 등록할 수 있습니다.
<추가상품 없는 샘플>
{
"items":[]
}<추가상품 수정 샘플>
{
"orderType":"ABC",
"items":[
{
"id":1,
"name":"포장 선택",
"value":"기본포장",
"price":1000,
"stockQuantity":10,
"usable":true,
"managedCode":"GIFT-001"
},
{
"id":2,
"name":"포장 선택",
"value":"선물포장",
"price":3000,
"stockQuantity":20,
"usable":true,
"managedCode":"GIFT-002"
}
]
}필드상세
| 필드명 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| id | Long | 선택 | 추가상품번호. 신규 등록시 빈값, 수정시 필수 입력. |
| name | String | 필수 | 추가상품명. 제약사항 참고 |
| value | String | 필수 | 추가상품값. 제약사항 참고 |
| price | Integer | 필수 | 추가상품값 개별 금액. 제약사항 참고 |
| stockQuantity | Integer | 필수 | 추가상품값 개별 재고수량. 제약사항 참고 |
| usable | Boolean | 필수 | 추가상품값 개별 사용여부. |
| managedCode | String | 선택 | 추가상품값 개별 판매자 관리코드. 제약사항 참고 |
AdditionalProductSortType
추가상품의 정렬기준
| 타입명 | 설명 |
|---|---|
| CREATE | 등록순 |
| ABC | 가나다순 |
| LOW_PRICE | 낮은 가격순 |
| HIGH_PRICE | 높은 가격순 |