Search Products Info

상품을 검색하기 위한 API

Search Products Info

GET /api/products

Access Permissions

Role	Description
ADMIN	관리자
MANAGER	CS 담당자
SELLER	판매자
CUSTOMER	구매자

Request Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Request Parameter

Name	Type	Description	Required
page	int	Page number	true
size	int	Page Size (10 - default, 30, 50)	false
sort	String	Value of the 'orderby' (createdAt - default, updatedAt, discountedPrice)	false
direction	String	Direction of the sorting (DESC - default, ASC)	false
productName	String	Keyword for product name search	false
companyName	String	Keyword for company name search	false
category	Integer	Category for the product search (default : 0)	false

Response

200

{ 
    "status": 200,
    "data": [
      {
        "productId": 1,
        "companyId": 1,
        "companyName": "업체1",
        "productName": "상품1",
        "productImageUrl": "https://s3~~~~~",
        "description": "상품1입니다.",
        "descriptionImageUrl": "https://s3~~~~~",
        "productOption": "RED",
        "originalPrice": 30000,
        "discountedPrice": 10000,
        "stock": 100,
        "categoryCode": 001,
        "saleStartTime": "2024-09-27 12:00:00",
        "saleEndTime": "2024-09-27 13:00:00",
        "rate": 3.4,
        "isSoldout": false
      },{
        "productId": 2,
        "companyId": 1,
        "companyName": "업체1",
        "productName": "상품2",
        "productImageUrl": "https://s3~~~~~",
        "description": "상품2입니다.",
        "descriptionImageUrl": "https://s3~~~~~",
        "productOption": "BLUE",
        "originalPrice": 30000,
        "discountedPrice": 10000,
        "stock": 100,
        "categoryCode": 001,
        "saleStartTime": "2024-09-27 12:00:00",
        "saleEndTime": "2024-09-27 13:00:00",
        "rate": 3.8,
        "isSoldout": false
      }
    ],
    "error": null,
    "timeStamp": "2024-09-27 12:00:00"
}

ERROR

{ 
    "status": 400, // ERROR 코드 ex) 400, 401, 403, 404 등
    "data": null,
    "error": {
        "message": "ERROR 발생 시 e.getmessage 결과"
    },
    "timeStamp": "2024-09-27 12:00:00"
}