이 섹션의 문서

더보기

대량 상품목록 조회

페이지 제한없이 대량 상품을 조회하기 위해 사용합니다.

정렬기준의 종류는 SortProperty 를 참고 해 주시고 정렬 순서는 기준별 역순입니다.

 

최초 조회 요청(cursor 값 없이 요청)시, 해당 조회 문서의 마지막 위치를 nextCursor 로 응답. cursor 입력 후 요청 시 해당 커서 이후의 상품목록이 조회됩니다.

(예시)

1) 최초 조회 요청 시

 - [요청] cursor : 없음
   [응답] nextCursor : 있음, last : false     >> (결과예시. 1~100까지의 상품목록 조회)

2) 그 다음 추가 요청 시

 - [요청] cursor : 있음  (1번에서 응답받은 nextCursor 입력)
   [응답] nextCursor : 있음, last : false     >> (결과예시. 101~200까지의 상품목록 조회)

3) 그 다음 추가 요청 시 마지막 페이지인 경우

 - [요청] cursor : 있음  (2번에서 응답받은 nextCursor 입력)
   [응답] nextCursor : 없음, last : true

 

요청

GET /v2/store/products/by-cursor?cursor=1&size=100&sortProperty=CREATED_AT&sortOrder=ASC HTTP/1.1

<요청 패러미터 설명>

 키  타입  필수여부  설명
sortProperty SortProperty 선택 정렬기준. 값이 없는 경우 등록일(CREATED_AT) 기준입니다.
sortOrder String 선택 기본값은 내림차순인 “DESC”, 오름차순인 경우 “ASC” 입니다.
size Integer 선택 요청 페이지 당 상품수. 기본값은 100. 최대 1,000까지 입력 가능.
cursor String 선택 조회된 문서 위치. 최초 조회 시에만 값 없이 요청. 값이 없는 경우 첫번째 페이지로 조회됩니다.
displayedSaleStatus DisplayedSaleStatus 선택 판매상태 검색조건. 값이 없는 경우 모든 상태 조회됩니다.

 

응답

<응답 바디>

 필드명  타입  필수여부  설명
contents Array<ProductList> 필수 목록에 필요한 상품정보 리스트
totalCount Integer 필수 등록된 전체 상품수
condition CursorRequest 필수 요청한 커서 정보 참고용입니다.
last Boolean 필수 마지막 페이지 여부
nextCursor String 선택 조회된 문서의 마지막 위치

 

<응답 바디 샘플>

{
  "contents": [
    {
      "productId": 10045209,
      "imageUrl": "https://st.kakaocdn.net/winterfell_sandbox/product/20240626135358_38a80b5de4be4157899f2f7515462d6d.png",
      "storeManagementCode": "WC8CCE2",
      "name": "openapi 예약 상품 스웨거 등록(3)_날짜포맷X",
      "productSaleStatus": "ON_SALE",
      "displayStatus": "OPEN",
      "brand": "big",
      "salePrice": 16500,
      "storeDiscount": "2000",
      "adminDiscount": "2000",
      "optionType": "COMBINATION",
      "bundleGroupAvailable": false,
      "deliveryFeeType": "FREE",
      "deliveryPaymentType": "NONE",
      "deliveryBaseFee": 0,
      "deliveryMethodType": "NONE",
      "categoryWholeName": "여행/레저/자동차>국내여행>제주도>패키지",
      "useSalePeriod": true,
      "salePeriod": {
        "from": "20240703000000",
        "to": "20250703000000"
      },
      "shareDiscountStatus": "UNSET",
      "groupDiscountStatus": "UNSET",
      "talkDisplayable": true,
      "shoppingHowDisplayable": true,
      "createdAt": "20240703143232",
      "lastModifiedAt": "20240703143232"
    }
  ],
  "condition": {
    "size": 100,
    "cursor": "jbNrvpZr344LImbaSnIeA2V22JwZyw8lRCIytXVNbFl8I1da70BtdkjIR_FCKs2wNCqWKFy7eZUuGViNgG8f1g"
  },
  "totalCount": 148,
  "nextCursor": "jbNrvpZr344LImbaSnIeA5kDpLUZX0Y_82aaR0oHOYQFcTAbej8Q3zB80UnTCJeRNCqWKFy7eZUuGViNgG8f1g",
  "last": false
}

 

 

 

 

 

관련 문서