> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/back-office/goods-bo/undefined-7.md).

# 단품 정보 관리

상품의 단품에 대한 상세 정보를 조회하고 관리하는 기능을 제공합니다. 또한, **옵션 정보관리 API**는 옵션에 대한 정보를 조회하고 관리하는 기능을 제공합니다.

***

#### 주요 기능

* **단품 정보 조회 및 일괄 수정**

  * 상품 등록일자, 협력사 번호, 표준카테고리 등 다양한 조건으로 단품 정보를 조회할 수 있습니다.
  * 조회된 결과를 기반으로 판매상태, 안전재고 기준 수량, 재고수량 등을 일괄적으로 수정할 수 있습니다.

* **옵션 정보 조회 및 관리**
  * 옵션분류유형과 사용여부에 따라 옵션분류코드목록과 옵션코드목록을 조회할 수 있습니다.
  * 조회된 옵션코드목록에는 이미지 및 RGB값을 등록할 수 있습니다.
  * 등록된 값들은 FO 상품상세 페이지에서 확인할 수 있습니다.

## 프로세스 정의

<figure><img src="/files/uNVHObUh017rDX1HD7dK" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 단품목록 조회

* 검색조건에 따라 단품 목록을 조회
* 전체기간 검색 여부와 재고부족 여부를 지정하여 단품 조회가 가능
  {% endstep %}

{% step %}

### 단품관리 목록 저장

* 변경된 단품관리 목록을 저장
* 재고수량, 안전재고 기준수량, 안전재고 알림 여부 등을 변경 가능
* 상품번호, 단품번호 필수값 미입력시 오류 반환
  {% endstep %}

{% step %}

### 안전재고 알림기준수량 일괄 변경

* 선택한 단품들의 안전재고 알림 기준수량을 일괄 변경
* 안전재고 알림 여부가 ’Y’일 경우에만 변경
* 상품번호, 단품번호, 안전재고알림 기준수량 미입력시 오류 반환
  {% endstep %}

{% step %}

### 재고수량 일괄 변경

* 선택한 단품들의 재고수량을 일괄 변경
* 재고관리 여부가 ’Y’일 경우에만 변경
* 상품번호, 단품번호, 재고수량 미입력시 오류 반환
  {% endstep %}

{% step %}

### 단품 품절 처리

* 선택한 단품 목록을 품절 처리
* 배송 모듈의 결품 관리에서 결품 처리를 위해 호출
  {% endstep %}
  {% endstepper %}

<figure><img src="/files/tnD2BSUXSHi5ydCzAWU2" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 옵션 분류 코드 목록 조회

* 옵션 분류 코드 정보 목록 조회 기능 제공
* 정렬 순서는 오름차순, 수정일시는 내림차순으로 정렬됨
  {% endstep %}

{% step %}

### 옵션코드 목록 조회

* 옵션 분류 번호 기준으로 옵션 코드 정보 목록을 조회
* 정렬 순서는 오름차순, 수정일시는 내림차순으로 정렬됨
  {% endstep %}

{% step %}

### 옵션 분류 코드 목록 저장

* 옵션 분류 코드 정보 목록 저장 기능 제공
* 옵션 분류명 수정시 단품 옵션 정보의 옵션 분류명도 수정됨
* 옵션 분류명은 중복 불가
* 목록 저장시 옵션 분류 코드 정보 유효성 검증 진행
  {% endstep %}

{% step %}

### 옵션코드 목록 저장

* 옵션 코드 정보 목록 저장
* 옵션명 수정시 단품 옵션 정보의 옵션명도 수정
  {% endstep %}
  {% endstepper %}

## API 기능 목록

<table><thead><tr><th width="101.22216796875">API</th><th width="377.6666259765625">설명</th><th width="95.7777099609375">Server</th><th width="91.3333740234375">메소드</th><th>비고</th></tr></thead><tbody><tr><td>안전재고 알림 기준 수량 일괄 변경</td><td>•선택한 단품들의 안전재고 알림 기준수량을 일괄 변경합니다. <br>•안전재고 알림 여부가 Y인 경우에만 반영되며, N인 경우 반영되지 않습니다. <br>•안전재고알림여부가 N인 경우, 안전재고알림기준수량이 초기화됩니다.</td><td>BO</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗API 확인하기 ></a></td></tr><tr><td>재고수량 일괄 변경</td><td>•선택한 단품들의 재고수량을 일괄 변경합니다. <br>•재고관리 여부가 Y인 경우에만 반영되며, N인 경우 반영되지 않습니다.</td><td>BO</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗API 확인하기 ></a></td></tr><tr><td>단품 품절 처리</td><td>•단품 목록을 품절 처리합니다. <br>•배송 모듈의 결품관리에서 결품 처리를 위해 호출됩니다.</td><td>BO</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗API 확인하기 ></a></td></tr><tr><td>옵션 분류 코드 목록 조회</td><td>•옵션 분류 코드 정보 목록을 조회합니다. <br>•정렬순서는 오름차순, 수정일시는 내림차순으로 정렬됩니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%98%B5%EC%85%98%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getOptionList">🔗API 확인하기 ></a></td></tr><tr><td>옵션코드 목록 조회</td><td>•옵션분류번호를 기준으로 옵션 코드 정보 목록을 조회합니다. <br>•정렬순서는 오름차순, 수정일시는 내림차순으로 정렬됩니다.</td><td>BO</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗API 확인하기 ></a></td></tr><tr><td>옵션 분류 코드 목록 저장</td><td>•옵션 분류 코드 정보 목록을 저장합니다. <br>•옵션 분류명 수정시, 단품 옵션 정보의 옵션분류명도 수정됩니다. <br>•옵션 분류 코드 목록 저장시 입력한 옵션 분류 코드 정보의 유효성을 검증합니다. <br>•옵션분류명은 중복이 불가능합니다.</td><td>BO</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗API 확인하기 ></a></td></tr><tr><td>옵션코드 목록 저장</td><td>•옵션코드 정보 목록을 저장합니다. <br>•옵션 분류명 수정시, 단품 옵션 정보의 옵션분류명도 수정됩니다. <br>•옵션코드 목록 저장시 입력한 옵션 분류 코드 정보의 유효성을 검증합니다.</td><td>BO</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗API 확인하기 ></a></td></tr></tbody></table>

## 용어 정의

<table><thead><tr><th width="96.22216796875">명칭</th><th>설명</th><th data-hidden></th></tr></thead><tbody><tr><td>상품</td><td>•상거래 채널을 통해 판매의 대상이 되는 모든 재화를 의미합니다. <br>•상품을 전시하는 기본 단위이며 상품 상세 화면을 구성하는 기본 단위가 됩니다. <br>•상품은 가격을 관리하는 단위입니다.</td><td></td></tr><tr><td>단품</td><td><p>•상품 하위의 최소 관리 단위로 상품 재고 및 판매의 최소 단위, 즉 고객이 구입하게 되는 단위입니다. <br>•고객의 선택 옵션에 따른, 주문 상품 정보를 관리하는 단위입니다. <br>•재고를 관리하는 단위입니다. (솔루션에서 재고는 ‘웹재고’를 의미합니다.) <br>•옵션의 조합으로 단품 정보가 생성됩니다.</p><ul><li>(예) 단품A : 컬러-블랙/사이즈-260 / 단품B : 컬러-블랙/사이즈-250</li></ul></td><td></td></tr><tr><td>옵션</td><td>•상품을 베리에이션하는 기본 단위입니다. <br>•‘컬러’, ‘사이즈’ 등의 항목을 옵션명이라 하며 ‘블랙’, ‘XL’등을 옵션값이라 합니다. <br>•옵션 유형은 성별, 색상, 크기, 중량, 용량, 지역 등 대부분의 커머스에 사용하는 유형이 존재하며 사이트별 필요시 추가하여 사용할 수 있습니다.</td><td></td></tr><tr><td>일반상품 (구분)</td><td>•일반적인 배송이 이루어지는 모든 재화 상품을 의미합니다.</td><td></td></tr><tr><td>사은품 (구분)</td><td>•프로모션이나 이벤트 등을 통해 특정 상품 구매 혹은 특정한 액수 이상 구매 등과 같이 일정한 조건을 충족하는 고객에 한하여, 추가 비용 없이 지급하는 상품을 의미합니다.</td><td></td></tr><tr><td>일반상품</td><td>•단품에 상품의 옵션을 코드화에서 관리하는 상품을 의미합니다. <br>•재고 차감은 단품 단위로 이루어 집니다.</td><td></td></tr><tr><td>묶음상품</td><td>•할인 여부와 상관없이 전시 활용을 위한 묶음 상품을 의미합니다. <br>•옵션 구성 상품을 일부 선택하여 구매합니다.</td><td></td></tr></tbody></table>

<br>