안녕하세요. 카카오 쇼핑입니다.
톡스토어 상품목록 조회 성능 개선을 위해
상품목록 조회(v2) API 및 대량 상품목록 조회 API 신규 추가 제공 안내 드립니다.
◼︎ 문서오픈일 : 2024년 10월 29일 (화)
◼︎ 상세 내용
상품 판매상태 조건으로 상품목록 조회 가능해지며,
nextCursor 기반 검색으로 대규모 상품 스토어의 검색 성능이 개선됩니다. 대량 상품 조회하시는 경우, 신규 제공되는 '대량 상품목록 조회 API' 를 사용해주시기 바랍니다.
1. NEW 상품목록 조회(v2) API 신규 제공
1-1) 정렬기준, 정렬방식 필드명이 변경되고, 상품 판매상태 조건으로 검색이 가능해집니다.
- 정렬기준 : productOrder ➡︎ sortProperty 로 변경
- 정렬방식 : pageOrder ➡︎ sortOrder 로 변경
- 판매상태 검색조건 추가
- 기존 : 없음
- 변경 : displayedSaleStatus 신규 추가
1-2) 상품목록 조회 시, page*size 최대 5만개 조회로 제한됩니다.
- 기존 : 최대 제한 없음 (제한 없었으나, 실제 정상 조회 불가했음)
- 변경 : page*size 최대 5만개 까지로 제한 조회 (size는 최대 1,000개 제한 유지)
(ex) size 가 200 인 경우 → page 는 250 까지 가능
size 가 1,000 인 경우 → page 는 50 까지 가능
*기존 상품목록 조회(v1) API 는 추후 점차 Fadeout 예정입니다. (별도 일정으로 안내 및 진행 예정)
*상세 API 문서 경로 : API Docs > 톡스토어 상품 > 톡스토어 상품 API 명세 > 상품목록 조회(v2)
2. NEW 대량 상품목록 조회 API 신규 제공
- 페이지 제한없이 대량 상품을 조회하기 위해 사용하실 수 있는 대량 상품목록 조회 API 가 신규 제공됩니다.
[사용방법]
- 최초 조회 요청(cursor 값 없이 요청) 시, 해당 조회 문서의 마지막 위치를 nextCursor 로 응답합니다.
- cursor 값이 없는 경우 첫번째 페이지로 조회됩니다.
- cursor 입력 후 요청 시, 해당 커서 이후의 상품목록이 조회됩니다.
(예시)
1) 최초 조회 요청 시
- [요청] size : 100, cursor : 없음
[응답] last : false, nextCursor : 있음
>> 결과예시) 1~100 까지의 상품목록 조회
2) 그 다음 목록 추가 요청 시
- [요청] size : 100, cursor : 있음(1번에서 응답받은 nextCursor 값 입력)
[응답] last : false, nextCursor : 있음
>> 결과예시) 101~200 까지의 상품목록 조회
3) 그 다음 목록 추가 요청 시 마지막 페이지인 경우
- [요청] size : 100, cursor : 있음(2번에서 응답받은 nextCursor 값 입력)
[응답] last : true, nextCursor : 없음
>> 결과예시) 201~245 까지의 상품목록 조회
*상세 API 문서 경로 : API Docs > 톡스토어 상품 > 톡스토어 상품 API 명세 > 대량 상품목록 조회
관련하여 추가 문의사항은 아래 주소로 접속하셔서 전달 부탁드립니다.
*문의하기 > http://kko.to/G5xpSFS4j
감사합니다.