1.0

get /v1/products

Description

List products.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	LIMIT Example : `10`	integer	None
query	page optional	Page Example : `1`	integer	None
query	product_category_id optional	Product Category ID Example : `NETWORKING`	array[any of [string, null]]	[]
query	product_id optional	Product ID Example : `VPC`	array[any of [string, null]]	[]
query	display_name optional	Product name Example : `VPC`	array[any of [string, null]]	[]
query	display_name_ko optional	Product name Example : `VPC`	array[any of [string, null]]	[]
query	kind optional	Product Kind Example : `PRODUCT`	array[any of [string, null]]	[]
query	created_start_date optional	Created start date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	created_end_date optional	Created end date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	modified_start_date optional	Modified start date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	modified_end_date optional	Modified end date Example : `2024-01-01T00:00:00`	any of [string (date-time), null]	None
query	sort optional	Sort Example : `created_at:asc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ProductListResponse
400	Bad Request	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/products

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = product 1.0"

Example HTTP response

Response 200

{
    "count": 5,
    "current_page": 1,
    "products": [
        {
            "created_at": "2024-01-01T00:00:00",
            "created_by": "5cada9f6afa049418c4f18c0c4859202",
            "display_name": "VPC",
            "display_name_ko": "VPC",
            "kind": "PRODUCT",
            "modified_at": "2024-01-01T00:00:00",
            "modified_by": "5cada9f6afa049418c4f18c0c4859202",
            "product_category_id": "NETWORKING",
            "product_category_name": "Networking",
            "product_id": "VPC"
        }
    ],
    "total_count": 5,
    "total_pages": 1
}