sayren Docs
카테고리

카테고리 등록

POST
/v1/categories

Authorization

bearer
AuthorizationBearer <token>

userToken(계정 스코프) 또는 storeToken(스토어 스코프)

In: header

Header Parameters

idempotency-key?string

멱등키. 같은 키로 다시 보내면 처음 결과를 돌려주고 한 번만 적용한다. 재시도에는 같은 키를 쓴다

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string
Length1 <= length <= 100
parentId?string|null
sortOrder?integer
visible?boolean
showPc?boolean
showMobile?boolean
productSort?string

Value in

  • "RECENT"
  • "POPULAR"
  • "PRICE_LOW"
  • "PRICE_HIGH"
  • "NAME"
metaTitle?|
Lengthlength <= 100
metaDescription?|
Lengthlength <= 300
metaKeywords?|
Lengthlength <= 200

Response Body

application/json

curl -X POST "https://example.com/v1/categories" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "meta": {    "status": 201,    "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}

카테고리 목록 조회 GET

쿼리에 따라 응답 형태가 다르다. 스코프 `category:r`. - 기본: `Category[]` — `parentId`의 직계 자식(생략하면 최상위). `flat=true`면 전체를 깊이·순서대로 평탄화한다. - `tree=true`: `CategoryTreeNode[]` — 최상위부터 `children`을 재귀로 채운 트리다. - `q` 지정: `CategorySearchResult[]` — 이름 검색 결과로 `fullPath`·`ancestors`가 붙는다. `q`가 `tree`보다 우선한다. 아래 응답 스키마는 기본 형태다.

카테고리 상세 조회 GET

다음