카테고리
카테고리 목록 조회
쿼리에 따라 응답 형태가 다르다. 스코프 `category:r`. - 기본: `Category[]` — `parentId`의 직계 자식(생략하면 최상위). `flat=true`면 전체를 깊이·순서대로 평탄화한다. - `tree=true`: `CategoryTreeNode[]` — 최상위부터 `children`을 재귀로 채운 트리다. - `q` 지정: `CategorySearchResult[]` — 이름 검색 결과로 `fullPath`·`ancestors`가 붙는다. `q`가 `tree`보다 우선한다. 아래 응답 스키마는 기본 형태다.
쿼리에 따라 응답 형태가 다르다. 스코프 category:r.
- 기본:
Category[]—parentId의 직계 자식(생략하면 최상위).flat=true면 전체를 깊이·순서대로 평탄화한다. tree=true:CategoryTreeNode[]— 최상위부터children을 재귀로 채운 트리다.q지정:CategorySearchResult[]— 이름 검색 결과로fullPath·ancestors가 붙는다.q가tree보다 우선한다.
아래 응답 스키마는 기본 형태다.
Authorization
bearer AuthorizationBearer <token>
userToken(계정 스코프) 또는 storeToken(스토어 스코프)
In: header
Query Parameters
parentId?string
이 카테고리의 직계 자식만. 생략하면 최상위 카테고리. flat=true면 무시
flat?string
true면 전체 카테고리를 깊이·순서대로 평탄화
Value in
- "true"
- "false"
tree?string
true면 최상위부터 children을 채운 트리(CategoryTreeNode[])를 돌려준다
Value in
- "true"
- "false"
q?string
이름 검색(포함, 대소문자 무시). 주면 fullPath·ancestors가 붙은 검색 결과를 돌려준다
Response Body
application/json
curl -X GET "https://example.com/v1/categories"{ "meta": { "status": 200, "code": "OK", "message": "OK", "isSuccess": true }, "data": [ { "categoryId": "string", "storeId": "string", "name": "string", "parentId": "string", "path": "string", "depth": 1, "leaf": true, "sortOrder": 0, "visible": true, "showPc": true, "showMobile": true, "productSort": "RECENT", "metaTitle": "string", "metaDescription": "string", "metaKeywords": "string", "createdAt": "string", "updatedAt": "string" } ], "error": null}