Superfid Docs
개발자 문서외부 재고 API

위치·section 목록

재고 범위 조회에 사용할 위치 계층과 ID를 가져옵니다.

Endpoint

항목값
MethodGET
Path/v1/external/locations
인증Authorization: Bearer <developer-key>

요청

curl --fail-with-body "$API_BASE_URL/v1/external/locations" \
  -H "Authorization: Bearer $SUPERFID_DEVELOPER_KEY" \
  -H "Accept: application/json"

응답

{
  "locations": [{
    "id": "location-uuid",
    "name": "시흥 센터",
    "code": "SIHEUNG",
    "parentId": null,
    "parentName": null,
    "nodeKind": "location",
    "depth": 0,
    "pathIds": ["location-uuid"],
    "pathNames": ["시흥 센터"],
    "displayPath": "시흥 센터",
    "isLeaf": false,
    "childCount": 1,
    "selectable": false,
    "status": "active",
    "updatedAt": "2026-09-18T01:23:45.000Z"
  }]
}

필드 사용법

  • id: 재고 목록·SKU 상세·변동 이력의 scopeLocationId로 사용할 위치 ID입니다.
  • parentId, pathIds, displayPath: root·section·leaf 계층을 화면에 표시할 때 사용합니다.
  • isLeaf: 하위 위치가 없는 위치인지 나타냅니다.
  • selectable: 현재 workspace에서 재고 범위를 선택할 수 있는지 나타냅니다.
  • status: 현재 활성 위치만 재고 조회 대상이 됩니다.

root, section, leaf 중 어느 ID든 scopeLocationId로 전달할 수 있습니다. section을 선택하면 그 하위 leaf들의 재고가 합산됩니다.

On this page