> 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.md).

# 상품 공통

상품 메뉴에서 사용하는 기능을 효율적으로 제공하여, 상품 현황, 문의 현황 및 차트에 필요한 상품 요약 정보를 조회합니다. 이는 BO 메인 화면에서 사용자가 상품에 대한 간략한 정보를 한눈에 확인할 수 있도록 도와줍니다.

***

## 주요 기능

* **상품 대시보드 API**
  * 사용자가 한눈에 상품에 대한 간략한 정보를 확인할 수 있도록 제공합니다.
  * 상품의 현황 및 문의 현황을 시각적으로 제공하여 효과적인 상품 관리를 지원합니다.
* **상품 공통 API**
  * 상품 개발 시 필요한 내용을 공통으로 분류하여 재사용성을 높입니다.
  * 상품 요약 정보를 효율적으로 조회하며, 필수적인 공통 기능을 포함합니다.
* **상품관리 공통 팝업 API**
  * 상품 목록을 조회하고 판매 상태를 일괄 변경하는 기능을 제공합니다.
  * 팝업 형태로 간편한 상품 관리를 지원하여 사용자 편의성을 향상시킵니다.
* **상품 전체보기 팝업 API**
  * 상품 목록에서 재고 정보를 포함한 상세 정보를 조회하는 기능을 제공합니다.
  * 사용자가 상품에 대한 전반적인 정보를 확인할 수 있도록 합니다.

## 프로세스 정의\_ 대시보드

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

{% stepper %}
{% step %}

### 상품문의 현황 조회

* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회
* request값에 이관처리상태코드(CS006)가 있는 경우 해당코드에 해당하는 문의목록만 조회
* 최신 등록일 순으로 상위 10건의 문의목록만 조회합니다.
  {% endstep %}

{% step %}

### 상품요약 정보 조회

* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회
* 각 구분 값(주문, 찜, 장바구니)에 대하여 가장 많은 이벤트가 발생한 상품을 조회
* 최근 7일 이내의 상품으로 조회
  {% endstep %}

{% step %}

### 상품현황 조회

* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회
* 재고관리 하는 상품의 경우 안전재고수량보다 재고가 적은 상품의 상품상태는 재고부족으로 조회
  {% endstep %}
  {% endstepper %}

## 프로세스 정의\_ 상품 공통

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

{% stepper %}
{% step %}

### 상품 기본 정보 조회

* 상품 기본 정보를 조회
  {% endstep %}

{% step %}

### 일반상품 정보 조회

* 일반상품의 상품정보를 조회
  {% endstep %}

{% step %}

### 묶음상품 정보 조회

* 묶음상품의 상품정보를 조회
  {% endstep %}

{% step %}

### 사은품 정보 조회

* 사은품 정보를 조회
  {% endstep %}

{% step %}

### 상품고시항목 목록 조회

* 상품고시항목코드에 따른 상품고시항목의 목록을 조회
  {% endstep %}

{% step %}

### 상품 카테고리 속성 목록 조회

* 표준카테고리에 매핑한 상품속성정보 목록을 조회
  {% endstep %}

{% step %}

### 협력사 기본 정보 조회

* 협력사 번호에 따른 협력사 기본 정보를 조회
  {% endstep %}

{% step %}

### 배송비/반품비 정책 목록 조회

* 협력사에 따른 배송비/반품비 정책 목록을 조회
  {% endstep %}

{% step %}

### 가격 변경 예약 등록/취소

* 가격 변경 예약을 등록하거나 취소
* 가격변경요청코드에 따라 등록과 취소를 구분
* 기존에 가격 변경 예약이 등록되어 있는 경우 기존 등록된 항목을 삭제하고 요청한 정보를 등록
* 경우 필수 값을 모두 입력 \
  a. 공급원가, 정상가, 판매가, 마진율, 이력시작일시, 가격변경사유코드(PR033)
  {% endstep %}

{% step %}

### 현재 적용 중인 행사가 조회

* 현재 상품에 적용중인 행사가 정보를 조회
  {% endstep %}

{% step %}

### 행사가 등록/변경

* 행사가 예약 정보를 등록 또는 변경, 삭제
* 가격변경요청코드에 따라 등록과 취소를 구분
* 기존에 행사가 예약 정보가 등록되어 있는 경우 기존 등록된 항목을 삭제하고 요청한 정보를 등록
* 경우 필수 값을 모두 입력 \
  a. 공급원가, 정상가, 판매가, 마진율, 이력시작일시, 가격변경사유코드(PR033)
  {% endstep %}

{% step %}

### 일반상품 수정

* 일반상품 정보를 수정
* 판매상태를 품절로 변경 시 상품과 상품 내 판매중인 모든 단품의 판매상태가 품절로 변경되며, 품절사유는 '관리자 품절' 사유로 저장
* 판매상태가 종료인 상품은 상품정보를 수정할 수 없음
* 예약판매 중인 상품의 판매상태가 품절인 경우 판매 중으로 변경할 수 없음
* 필수 값을 모두 입력하지 않은 경우 오류 메시지를 보냄
  {% endstep %}

{% step %}

### 묶음상품 수정

* 묶음상품 정보를 수정
* 판매상태가 종료인 상품은 상품정보를 수정할 수 없음
* 필수 값을 모두 입력하지 않은 경우 오류 메시지를 보냄
  {% endstep %}

{% step %}

### 사은품 수정

* 사은품 정보를 수정
* 판매상태가 종료인 사은품은 사은품정보를 수정할 수 없음
* 필수 값을 모두 입력하지 않은 경우 오류 메시지를 보냄
  {% endstep %}

{% step %}

### 상품정보 일괄수정

* 선택한 상품들의 전시카테고리 또는 홍보문구를 일괄 수정
* 홍보문구를 수정하는 경우 기존 홍보문구를 삭제하고 요청한 홍보문구로 변경
  {% endstep %}

{% step %}

### 단품 옵션목록 조회

* 단품 옵션목록을 조회
  {% endstep %}

{% step %}

### 단품 판매상태 목록 조회

* 단품 판매상태 목록을 조회
  {% endstep %}

{% step %}

### 아이콘 정보 조회

* 상품에 등록된 아이콘 정보를 조회
  {% endstep %}

{% step %}

### 상품 다국어 정보 조회

* 상품에 현재 등록된 모든 다국어 정보를 리스트로 조회
  {% endstep %}

{% step %}

### 상품 다국어 정보 등록/수정

* 상품의 다국어 정보들 등록하거나 수정
* 필수 값을 모두 입력하지 않은 경우 오류 메시지를 보냄
  {% endstep %}

{% step %}

### 표준카테고리별 전시카테고리 목록 조회

* 표준카테고리별 전시카테고리 목록을 조회
  {% endstep %}
  {% endstepper %}

## 프로세스 정의\_ 상품관리 공통 팝업

<figure><img src="/files/9HMQdJvst5bh8gwv54jC" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 상품 목록 조회

* 검색 조건에 따라 상품 목록을 조회
* 상품번호를 입력한 경우 상품 등록기간 조건을 무시하고 전체기간 조회
  {% endstep %}

{% step %}

### 판매상태 일괄변경

* 상품 또는 단품의 판매상태를 일괄적으로 변경
  {% endstep %}
  {% endstepper %}

## API 기능 목록\_ 대시보드

<table><thead><tr><th width="126.7777099609375">API</th><th width="303.888916015625">설명</th><th width="94.666748046875">Server</th><th width="91.333251953125">메소드</th><th>비고</th></tr></thead><tbody><tr><td>상품문의 현황 조회</td><td>•대시보드에 노출될 상품문의 현황을 조회합니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗API 확인하기 ></a></td></tr><tr><td>상품요약 정보 조회</td><td>•대시보드에 노출될 상품요약 정보를 조회합니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getGoodsSummary">🔗API 확인하기 ></a></td></tr><tr><td>상품현황 조회</td><td>•대시보드에 노출될 상품현황을 조회합니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗API 확인하기 ></a></td></tr></tbody></table>

## API 목록\_ 상품 공통

<table><thead><tr><th width="113.4444580078125">API</th><th width="320.22216796875">설명</th><th width="92.4444580078125">Server</th><th width="90.22216796875">메소드</th><th>비</th></tr></thead><tbody><tr><td>상품 기본 정보 조회</td><td><ul><li>상품 기본 정보를 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGeneralGoodsInfo">🔗API 확인하기 ></a></td></tr><tr><td>일반상품 <br>정보 조회</td><td><ul><li>일반상품의 상품정보를 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗API 확인하기 ></a></td></tr><tr><td>묶음상품 <br>정보 조회</td><td><ul><li>묶음상품의 상품정보를 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getPackageGoodsInfo">🔗API 확인하기 ></a></td></tr><tr><td>사은품 정보 조회</td><td><ul><li>사은품 정보를 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getPackageGoodsInfo">🔗API 확인하기 ></a></td></tr><tr><td>상품고시<br>항목 목록 조회</td><td><ul><li>상품등록/수정/상세 페이지에서 필요한 상품고시항목 목록을 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGoodsNotificationItemList">🔗API 확인하기 ></a></td></tr><tr><td>상품 카테고리 속성 목록 조회</td><td><ul><li>상품등록/수정/상세 페이지에서 필요한 상품 카테고리 속성 목록을 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGoodsCtgAttInfoList">🔗API 확인하기 ></a></td></tr><tr><td>협력사 기본 정보 조회</td><td><ul><li>상품등록/수정/상세 페이지에서 필요한 협력사 기본 정보를 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getEtEntrBase">🔗API 확인하기 ></a></td></tr><tr><td>배송비/반품비 정책 목록 조회</td><td><ul><li>상품등록/수정/상세 페이지에서 필요한 배송비/반품비 정책 목록을 조회합니다</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getDisplayCategoryListByStandardCategory">🔗API 확인하기 ></a></td></tr><tr><td>가격 변경 예약 등록/취소</td><td><ul><li>가격 변경 예약을 등록 또는 취소합니다. </li><li>가격변경요청코드(rsvCudStat)에 따라 등록과 취소를 구분합니다 기존에 가격 변경 예약이 등록되어 있는 경우 기존 등록된 항목을 삭제하고 요청한 정보를 등록합니다</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGeneralGoodsPriceReservation">🔗API 확인하기 ></a></td></tr><tr><td>현재 적용 중인 행사가 조회</td><td><ul><li>현재 상품에 적용중인 행사가 정보를 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗API 확인하기 ></a></td></tr><tr><td>행사가 등록/변경</td><td><ul><li>행사가 예약 정보를 등록/변경합니다. 가격변경요청코드(rsvCudStat)에 따라 등록과 취소를 구분합니다 기존에 행사가 예약 정보가 등록되어 있는 경우 기존 등록된 항목을 삭제하고 요청한 정보를 등록합니다.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGeneralGoodsEventPriceReservation">🔗API 확인하기 ></a></td></tr><tr><td>일반상품 수정</td><td><ul><li>일반상품 정보를 수정합니다. 판매상태를 품절로 변경 시 상품과 상품 내 판매중인 모든 단품의 판매상태가 품절로 변경되며, 품절사유는 '관리자 품절' 사유로 저장됩니다</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGeneralGoods">🔗API 확인하기 ></a></td></tr><tr><td>묶음상품 수정</td><td><ul><li>묶음상품 정보를 수정합니다. 판매상태가 종료인 상품은 상품정보를 수정할 수 없습니다. 필수값을 모두 입력하지 않은 경우 오류 메시지를 보냅니다</li></ul></td><td>BO</td><td>POST</td><td><a href="http://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGiftGoods">🔗API 확인하기 ></a></td></tr><tr><td>사은품 수정</td><td><ul><li>사은품 정보를 수정합니다. 판매상태가 종료인 사은품은 사은품정보를 수정할 수 없습니다.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EB%8C%80%EC%8B%9C%EB%B3%B4%EB%93%9C&#x26;path=getQnASicuations">🔗API 확인하기 ></a></td></tr><tr><td>상품정보 일괄수정</td><td><ul><li>선택한 상품들의 전시카테고리, 홍보문구를 일괄 수정합니다. 선택한 상품들의 전시카테고리 또는 홍보문구를 일괄 수정합니다 홍보문구를 수정하는 경우 기존 홍보문구를 삭제하고 요청한 홍보문구로 변경합니다.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=modifyGoodsInfo">🔗API 확인하기 ></a></td></tr><tr><td>단품 옵션목록 조회</td><td><ul><li>단품 옵션목록을 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getItemOptionList">🔗API 확인하기 ></a></td></tr><tr><td>단품 판매상태 목록 조회</td><td><ul><li>단품 판매상태 목록을 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getGoodsSaleStateList">🔗API 확인하기 ></a></td></tr><tr><td>아이콘 정보 조회</td><td><ul><li>상품에 등록된 아이콘 정보를 조회합니다. NEW, BEST 아이콘은 수동 등록이 아니라 쿼리 조회시마다 노출 여부가 결정됩니다</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getPrGoodsIconInfoList">🔗API 확인하기 ></a></td></tr><tr><td>상품 다국어 정보 조회</td><td><ul><li>상품에 현재 등록된 모든 다국어 정보를 리스트로 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=registGoodsMultiLanguage">🔗API 확인하기 ></a></td></tr><tr><td>상품 다국어 정보 등록/수정</td><td><ul><li>상품의 다국어 정보들 등록하거나 수정합니다. 필수 값을 모두 입력하지 않은 경우 오류 메시지를 보냅니다.</li></ul></td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getDisplayCategoryListByStandardCategory">🔗API 확인하기 ></a></td></tr><tr><td>표준카테고리별 전시카테고리 목록 조회</td><td><ul><li>표준카테고리별 전시카테고리 목록을 조회합니다.</li></ul></td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=goods&#x26;depth=%EC%83%81%ED%92%88%20%EA%B3%B5%ED%86%B5&#x26;path=getDisplayCategoryListByStandardCategory">🔗API 확인하기 ></a></td></tr></tbody></table>

## API 기능 목록\_ 상품 공통 팝업

| API       | 설명                         | Server | 메소드  | 비고  |
| --------- | -------------------------- | ------ | ---- | --- |
| 상품 목록 조회  | •상품 목록을 조회합니다.             | BO     | GET  | --- |
| 판매상태 일괄변경 | •상품 또는 단품의 판매상태를 일괄 변경합니다. | BO     | POST | --- |

## API 기능 목록\_ 상품 전체보기 팝업

| API             | 설명                        | Server | 메소드 | 비고  |
| --------------- | ------------------------- | ------ | --- | --- |
| 상품(재고 포함) 목록 조회 | •재고 정보를 포함한 상품 목록을 조회합니다. | BO     | GET | --- |

## 용어 정의

<table><thead><tr><th width="127.3333740234375">명칭</th><th>설명</th></tr></thead><tbody><tr><td>대시보드</td><td>BO 시스템에 로그인 시 중앙에 나타나는 4개의 차트가 노출되는 구역입니다.</td></tr></tbody></table>

## 기타 참고사항

* 아이콘 정보 조회 API
  * NEW, BEST 아이콘은 수동 등록이 아니라 쿼리 조회시마다 노출 여부가 결정됩니다.
* 판매상태 일괄변경 API
  * 상품 또는 단품의 판매상태를 일괄적으로 변경합니다.
  * 상품 판매상태 일괄 변경을 하는 경우 상품번호만 입력하고 단품번호는 빈 값으로 입력합니다.
  * 상품 판매상태 일괄 변경 시에는 해당 상품의 모든 단품도 일괄적으로 상태를 변경합니다.
  * 판매중 -> 품절로 변경 시 판매중인 단품만 품절로 변경 됩니다.
  * 품절 -> 판매중으로 변경 시 단품 판매상태를 별도로 변경하지 않은 모든 품절 상태의 단품을 판매중으로 변경합니다.
  * 판매중으로 변경 시 재고가 없는 단품은 품절 배치가 작동할 때 자동으로 품절로 변경됩니다.
  * 단품 판매상태 일괄 변경을 하는 경우 상품번호와 단품번호를 모두 입력합니다.
  * 단품 판매상태 일괄 변경 시 모든 단품의 판매 상태가 변경되는 경우 상품의 판매상태도 함께 변경됩니다.