메인 콘텐츠로 건너뛰기
롯데온(lotteon.com)에서 상품을 검색하고 상품 페이지를 비동기 task API로 읽습니다. COMMERCE_SERP(site: lotteon)를 보내면 검색 결과의 상품을 쇼핑몰 순서대로 받고, COMMERCE_PRODUCT에 상품 url을 보내면 그 상품 하나를 읽습니다. 완료된 검색이나 상품 페이지 하나에 0.5크레딧입니다.

검색

task를 제출한 뒤 GET /v1/async/task/{id}를 폴링하거나 웹훅으로 받습니다. 참고: 비동기 task.

입력

  • site: 필수. lotteon입니다.
  • query: 필수. 검색어이며 1-500자입니다.
  • limit: 선택. 정수 1-40이며 기본값은 20입니다.
  • country: 선택. 기본값은 쇼핑몰의 국가인 KR입니다. 다른 국가는 422 REGION_UNSUPPORTED로 거절합니다.
위에 나열한 페이로드 필드만 받습니다. include는 생략합니다. include: {}도 크레딧을 확보하기 전에 payload.include의 422 VALIDATION_ERROR를 반환합니다.

응답 예시

결과 필드

  • site, query, country는 요청 값입니다. returnedCount는 products에 담긴 상품 수입니다.
  • 각 상품은 rank, productId, title, url을 담습니다. productId는 쇼핑몰 자체 상품 ID입니다. rank는 쇼핑몰의 기본 정렬 순서이며, 쇼핑몰이 광고로 표시한 상품은 건너뜁니다.
  • price, rating, reviewCount, imageUrl, brand 필드는 검색 결과 화면에 있을 때 담습니다. price는 상품별 currency(ISO 4217) 기준의 숫자이며, 용량별 가격이 다르면 가장 낮은 가격입니다.
  • rating은 5점 만점입니다. 999+처럼 줄여 표시한 리뷰 수는 담지 않습니다.
  • 검색마다 쇼핑몰의 첫 결과 페이지에서 상품을 가져옵니다.

상품 페이지

입력

  • url: 필수. 롯데온의 상품 페이지이며 2,048자 이하입니다. 주소 형식은 lotteon.com/p/product/{id}입니다. 검색 결과의 상품 url을 그대로 넣을 수 있습니다. 추적 코드처럼 결과에 영향이 없는 파라미터는 읽기 전에 뺍니다.
  • country: 선택. 기본값은 페이지의 국가인 KR입니다. 다른 국가는 422 REGION_UNSUPPORTED로 거절합니다.
위에 나열한 페이로드 필드만 받습니다. include는 생략합니다. include: {}도 크레딧을 확보하기 전에 payload.include의 422 VALIDATION_ERROR를 반환합니다.

응답 예시

결과 필드

  • site, country, url, productId로 페이지를 구분합니다. url은 읽은 페이지이고, productId는 검색 결과의 ID와 같습니다.
  • title은 항상 담습니다. brand, price, currency, inStock, seller, images, description, descriptionImages, specs, categories 필드는 페이지에 있을 때 담습니다.
  • price는 쿠폰과 배송비를 적용하기 전, 페이지가 처음 보여 주는 구매 가격이며 currency(ISO 4217) 기준입니다. inStock은 재고 여부입니다. seller는 판매자입니다.
  • images는 상품 갤러리의 사진을 페이지 순서대로 최대 30장 담습니다. 이 쇼핑몰은 대표 사진 하나만 담습니다.
  • description은 문단마다 한 줄인 일반 텍스트이며 최대 10,000자입니다. 이미지 안에만 있는 글은 담지 않습니다. 이 쇼핑몰은 상품 정보 대부분을 이미지로 보여 주므로 description이 있는 페이지는 많지 않습니다.
  • descriptionImages는 상품 설명의 이미지를 페이지 순서대로 최대 300장 담습니다. 판매자가 설명에 넣은 배너와 공지도 함께 담기며, 이미지 안의 글은 읽지 않습니다.
  • specs는 상품 정보의 { name, value } 쌍을 최대 100개 담습니다. categories는 가장 넓은 카테고리부터 가장 좁은 카테고리까지 최대 10단계입니다.

오류와 과금

  • 상품이 하나도 없는 검색은 실패한 task로 끝납니다.
  • 쇼핑몰이 404나 410으로 답하는 상품 페이지(삭제된 상품 등)는 PAGE_UNAVAILABLE로 끝나고, 메시지에 쇼핑몰의 응답을 담습니다. 쇼핑몰이 403, 412, 429, 435로 읽기를 거절하면 task는 기다렸다가 최대 6분 동안 다시 요청합니다. 그 밖의 읽기 실패와 그보다 오래 이어지는 거절은 ENGINE_NO_RESULT로 끝납니다.
  • 완료된 task에만 과금하며, 검색이나 상품 페이지 하나에 0.5크레딧입니다.

관련 문서