재고 API

창고 전체의 재고 수준을 실시간으로 모니터링합니다.

엔드포인트

GET

/inventory

inventory:read

모든 상품의 재고 수준을 조회합니다. 창고와 재고 부족 상태로 필터링할 수 있습니다.

GET

/inventory/:productId

inventory:read

모든 창고에서 특정 상품의 재고 정보를 조회합니다.

필드 참조

필드	유형	필수	설명
id	string	아니오	고유 재고 레코드 ID (읽기 전용)
productId	string	아니오	상품 식별자
productSku	string	아니오	상품 SKU
productName	string	아니오	상품명 (읽기 전용)
warehouseId	string	아니오	창고 식별자
warehouseName	string	아니오	창고명 (읽기 전용)
quantity	integer	아니오	현재 재고 수량
reservedQuantity	integer	아니오	대기 중인 주문의 예약 수량
availableQuantity	integer	아니오	사용 가능 수량 (수량에서 예약분 제외)
minThreshold	integer	아니오	재고 부족 알림 임계값
updatedAt	datetime	아니오	마지막 재고 업데이트 타임스탬프

쿼리 매개변수 (목록)

필드	유형	필수	설명
page	integer	아니오	페이지 번호 (기본값: 1)
limit	integer	아니오	페이지당 항목 수 (기본값: 20, 최대: 100)
warehouseId	string	아니오	창고 ID로 필터
lowStock	boolean	아니오	재고 부족 임계값 미만의 상품만 표시

예시

재고 수준 조회

bash

curl "https://api.mercozy.com/api/v1/external/inventory?lowStock=true" \
  -H "X-API-Key: mk_live_your_key_here"

특정 상품 재고 조회

bash

curl "https://api.mercozy.com/api/v1/external/inventory/prod_abc123" \
  -H "X-API-Key: mk_live_your_key_here"

응답 예시

json

{
  "data": {
    "productId": "prod_abc123",
    "productName": "Premium Widget",
    "sku": "WDG-001",
    "quantity": 42,
    "lowStockThreshold": 10,
    "warehouseId": "wh_main",
    "warehouseName": "Main Warehouse",
    "updatedAt": "2025-12-15T10:30:00Z"
  }
}