상품 상태 변경
상품의 상태 정보만 빠르게 변경할 수 있는 API입니다.
기존의 상품 정보 변경 API는 스냅샷을 생성하기 때문에 무겁고 전체 수정에 적합합니다. 반면, 이 API는 전시 상태, 판매 여부, 재고 수량 등 상태 정보만 선택적으로 갱신할 수 있어 불필요한 리소스 소비 없이 효율적으로 사용할 수 있습니다.
PUT
https://api.bootapi.com/v1/products/:product_id/status
사용 시나리오
다음과 같은 경우에 이 API를 사용하세요:
- 전시 상태 - 상품의 노출/비노출 빠른 전환
- 판매 상태 - 판매 시작/중지 처리
- 재고 관리 - 재고 수량 실시간 업데이트
- 타임 세일 - 한정 시간 할인 이벤트 적용
1
Server
SDK 설치
서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.
SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.
2
Server
상품 상태 변경 요청
변경할 상태 정보만 선택적으로 담아 API를 호출합니다.
요청 파라미터
| 파라미터 | 타입 | 설명 |
|---|---|---|
product_id | string | 상품 고유 번호 (URL 파라미터) |
status_display | boolean | 쇼핑몰 전시 여부 |
status_sale | boolean | 판매 상태 |
status_frozen | boolean | 판매금지 상태 |
status_review | boolean | 심사 후 판매 유무 |
use_display_period | boolean | 전시 기간 사용 여부 |
display_start_at | string | 전시 시작일 |
display_end_at | string | 전시 종료일 |
use_sale_period | boolean | 판매 기간 사용 여부 |
sale_start_at | string | 판매 시작일 |
sale_end_at | string | 판매 종료일 |
use_discount_period | boolean | 할인 기간 사용 여부 |
discount_start_at | string | 할인 시작일 |
discount_end_at | string | 할인 종료일 |
status_time_sale | boolean | 타임 세일 사용 여부 |
time_sale_start_at | string | 타임 세일 시작일 |
time_sale_end_at | string | 타임 세일 종료일 |
time_sale_discount_percent | float | 타임 세일 할인율 |
use_stock | boolean | 재고 관리 여부 |
stock | integer | 남은 재고 수량 |
stock_safe | integer | 안전 재고 임계값 |
use_stock_safe | boolean | 안전 재고 관리 여부 |
use_option_stock | boolean | 옵션별 재고 관리 여부 |
3
Server
응답 처리
HTTP 상태 코드로 성공 여부를 확인합니다. 성공 시 빈 객체가 반환됩니다.
에러 코드
PRODUCT_NOT_FOUND
상품을 찾을 수 없습니다.
올바른 product_id를 입력하거나, 해당 프로젝트의 상품인지 확인하세요.
PRODUCT_FROZEN
상품이 잠금 상태로 수정할 수 없습니다.
상품 잠금 상태를 해제한 후 수정하세요.
