개발자 문서/상품 최저가 조회

상품 최저가 조회 API

명세 내보내기OpenAPI 3.0.3Postman 컬렉션Markdown

검색어로 상품 등록 정보를 찾아 판매처와 가격을 한 번에 받고, 그중 최저가 상품을 lowest로 함께 확인합니다. 목록·검색 조회 한 건에 한 번만 과금되는 동기 API입니다.

POST/rest/shop_price
요청 예제로 이동 ↓

기능·제공 범위

인증
Bearer 키
요청
form-data
응답
JSON
요금·이용 조건
기본 단가 100P · 건당
이용 전 결제 필요

빠른 시작

서버의 APICK_API_KEY를 준비하고 입력값을 바꾸세요. 아래에서 경로별 입력·응답·실행 환경을 함께 확인할 수 있습니다.

요청과 응답

API 요청
POST/rest/shop_price

Bearer 인증 · multipart/form-data · JSON 응답

입력 항목
폼 항목·타입
필수
설명·예제
querystring
필수
검색어 (최대 100자)예: 무선 이어폰
displayinteger
선택
결과 수 (기본 10, 최대 100)예: 20
startinteger
선택
시작 위치 (기본 1, 최대 1000)
sortstring
선택
정렬 (기본 sim)허용값: sim, date, asc, dsc예: asc
응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

추가 입력 조건·전송 규칙
항목
설정
메서드·주소
POST https://apick.app/rest/shop_price
인증 헤더
Authorization: Bearer — 내 계정의 API 인증키
본문 형식
multipart/form-data
필수 항목
query — 검색어. 최대 100자
선택 항목
display 결과 수(기본 10, 최대 100), start 시작 위치(기본 1, 최대 1000), sort 정렬(sim 정확도·date 최신·asc 낮은 가격·dsc 높은 가격)
요청 예시

낮은 가격 순으로 20건을 받는 예입니다. 성공 시 과금되는 실제 요청입니다.

응답 상세

경로별 응답 예시와 필드 명세는 위 API 요청 설명에 붙어 있습니다. JSON을 파일로 저장하기 전에는 Content-Type과 오류를 확인하세요.

상태·오류·재시도

HTTP 상태 → API 처리 여부 → 업무 상태 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

서비스별 코드·조건 전체 보기

응답과 오류 복구

필드
타입
설명
data.total
integer
검색된 전체 상품 수입니다. 요청한 결과 수보다 클 수 있습니다.
data.start
integer
이번 응답이 시작한 위치입니다.
data.display
integer
이번 응답에 담긴 상품 수입니다.
data.items[]
array
상품 목록입니다.
data.items[].title
string
상품명입니다. 검색어 강조 태그는 제거된 평문입니다.
data.items[].link
string
상품 주소입니다.
data.items[].mallName
string
판매처 이름입니다.
data.items[].lprice
integer
최저가(원). 값이 없으면 0입니다.
data.items[].hprice
integer
최고가(원). 값이 없으면 0입니다.
data.lowest
object
가격이 있는 상품 중 최저가 상품입니다. 해당 상품이 없으면 null입니다.
api.cost
integer
차감된 포인트입니다. 실패한 응답은 0입니다.
api.ms
integer
처리 시간(밀리초)입니다.
{
  "data": {
    "total": 1200,
    "start": 1,
    "display": 20,
    "items": [],
    "lowest": { "lprice": 12900, "mallName": "판매처", "link": "https://apick.app", "title": "무선 이어폰" }
  },
  "api": { "cost": 100, "success": true, "ms": 210 }
}

검색어가 비어 있거나 100자를 넘거나 정렬 값이 잘못되면 조회 전에 data.error로 실패합니다. 상품 가격을 가져오지 못하면 공개 안내 문구가 오고 api.cost는 0입니다. 같은 검색을 반복하면 매번 과금되므로 다음 페이지는 start를 올려 한 번에 받으세요.

공통 폼 입력 오류

FORM_DATA_INVALID · HTTP 400: 필드 이름·타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.

FORM_DATA_FIELD_CONFLICT · HTTP 400: 같은 값과 중첩 경로를 동시에 지정하지 마세요.

MULTIPART_LIMIT_OR_PARSE_ERROR · HTTP 400/413: boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·제한·이용 조건

기능·제공 범위·요금·제한 전체 보기

이용 전 확인

성공한 조회 한 건당 100P가 차감됩니다. 검색 결과가 0건이어도 조회가 성공하면 같은 요금이 적용됩니다. 실제 차감액은 응답의 api.cost에서 확인하세요.

가격은 조회 시점의 판매처 등록값입니다. 배송비·옵션 추가금·쿠폰·회원 등급이 반영되지 않으므로 실제 결제 금액과 다를 수 있습니다. 최저가 비교의 참고값으로 사용하세요.

인증키는 서버 환경변수에 보관하고 공개 저장소·웹페이지에 넣지 마세요.

연동 시 확인할 내용

예제는 경로별로 최소 요청과 오류 처리 포함 모드를 제공합니다. 실제 사용 환경의 시간 제한·취소·업무 성공 판정을 적용하세요.

개발가이드 검색

필요한 API와 이용 요금을 함께 확인하세요.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.