1.0
1.0
get /v1/product-categories
Description
List product categories
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 한계 Example : 10 | integer | None |
| query | page optional | 페이지 Example : 1 | integer | None |
| query | display_name optional | 상품 카테고리 이름 Example : Networking | array[any of [string, null]] | [] |
| query | display_name_ko optional | 상품 카테고리 이름 Example : Networking | array[any of [string, null]] | [] |
| query | is_exposed_menu optional | 상품 카테고리 메뉴 노출 상태 Example : True | array[any of [boolean, null]] | [] |
| query | created_by optional | 생성자 Example : 김삼성 | any of [string, null] | None |
| query | modified_by optional | 수정자 Example : 김삼성 | any of [string, null] | None |
| query | created_start_date optional | 생성일 시작 Example : 2024-01-01T00:00:00 | any of [string (date-time), null] | None |
| query | created_end_date optional | 생성일 종료 Example : 2024-01-01T00:00:00 | any of [string (date-time), null] | None |
| query | modified_start_date optional | 수정일 시작 Example : 2024-01-01T00:00:00 | any of [string (date-time), null] | None |
| query | modified_end_date optional | 수정일 종료 Example : 2024-01-01T00:00:00 | any of [string (date-time), null] | None |
| query | sort optional | 정렬 Example : created_at:asc | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ProductCategoryListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/product-categories
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = product 1.0"
Example HTTP response
Response 200
{
"count": 5,
"current_page": 1,
"product_categories": [
{
"category_id": "NETWORKING",
"created_at": "2024-01-01T00:00:00",
"created_by": "5cada9f6afa049418c4f18c0c4859202",
"display_name": "Networking",
"display_name_ko": "Networking",
"icon_file_id": "c1d5c1f63bf24f73b32c37f6f7b50310",
"is_exposed_menu": "True",
"modified_at": "2024-01-01T00:00:00",
"modified_by": "5cada9f6afa049418c4f18c0c4859202",
"seq": 9,
"service_group_color_id": "ffff00"
}
],
"total_count": 5,
"total_pages": 1
}