상품 카테고리 목록 조회
POST/procedure-menu/open/categories/queries/get-categories
상품 카테고리 목록 조회
Request
### Content-Type별 요청의 JSON Schema
{
"application/json": {
"schema": {
"type": "object",
"properties": {
"sort": {
"allOf": [
{
"type": "object",
"properties": {
"by": {
"type": "string"
},
"order": {
"enum": [
"Order_UNKNOWN",
"ASC",
"DESC"
],
"type": "string",
"format": "enum"
}
},
"title": "protos.Sort"
}
],
"description": "정렬 기준"
},
"opened": {
"type": "boolean",
"description": "노출 여부n - `null`: 전체 조회n - `true`: 노출되는 카테고리만 조회n - `false`: 노출되지 않는 카테고리만 조회"
}
},
"title": "protos.open.OpenGetCategoriesQuery"
}
}
}
Responses
- 200
OK
### Status Code별 응답의 JSON Schema
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"id",
"name",
"order",
"deleted",
"opened",
"translsMap"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "카테고리 ID"
},
"name": {
"type": "string",
"description": "카테고리 이름"
},
"order": {
"type": "integer",
"description": "정렬 순서",
"format": "int32"
},
"deleted": {
"type": "boolean",
"description": "삭제 여부"
},
"opened": {
"type": "boolean",
"description": "노출 여부"
},
"translsMap": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"translation": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "protos.Transls"
},
"description": "다국어 번역 정보"
}
},
"title": "protos.procedure.Category"
}
}
},
"title": "protos.procedure.GetCategoriesQueryResponse"
}
}
}
}
}