판매상태 별 상품조회

해당 오픈 API 는 2023/8/8 부터 사용가능합니다.

판매상태별 상품정보를 조회할 때 사용합니다.

판매상태에 해당하는 상품목록을 조회할 수 있습니다.

요청

GET /v1/gift/products/sale-status/search?page={page}&size={size}&saleStatus={saleStatus}"

<요청 파라미터 설명>

응답

요청이 성공하면 응답 바디에 상품 목록이 조회 됩니다.
조회조건에 해당하지 않는 경우 빈 contents가 조회 됩니다.

<응답 바디>

- 판매상태 (SaleStatus) 가 판매금지 (PROHIBITION) 인 경우에만 판매금지 상세정보(ProhibitionDetailView)이 제공됩니다. 

<응답 바디 샘플>

- 조회조건에 해당하는 상품이 있는 경우

HTTP/1.1 200 OK 
Content-Type: application/json;charset=UTF-8

{
  "contents": [
    {
      "productId":1234,
      "saleStatus": "PROHIBITION",
      "prohibitionDetail": {
        "prohibitionModifiedAt": "20230101000000",
        "reasonType": "PRMS",
        "violationReason": "위반사유",
        "detailReason": "상세사유"
      }
    }
  ],
  "totalCount": 1,
  "last": true
}

<응답 바디 샘플>

- 조회조건에 해당하는 상품이 없는 경우

HTTP/1.1 200 OK 
Content-Type: application/json;charset=UTF-8

{
  "contents": [ ],
  "totalCount": 0,
  "last": true
}