Apinoa Docs

Browse

키워드 없이 Amazon 카테고리 하나의 상품을 나열합니다.

원본 .mdx 보기
GET | POST /v1/amazon/browse

파라미터는 GET의 쿼리 문자열로도, POST의 JSON 본문으로도 보낼 수 있습니다. 둘은 같습니다.

요청

curl "https://gateway.apinoa.com/v1/amazon/browse?categoryId=679416011&priceMax=50&sort=price_asc" \
  -H "x-api-key: $APINOA_API_KEY"

파라미터

파라미터타입필수설명
categoryIdstring예REQUIRED. An Amazon browse NODE — the digits from a category URL, e.g. 172541. The department slugs categories returns at its root (electronics) are NOT browse nodes and are refused with CATEGORY_NOT_BROWSABLE: call categories with the slug to get its child nodes and browse one of those.
brandsstring listBrand names as Amazon spells them, e.g. brands=Nike,Adidas. A call that uses brands costs 2 units instead of 1. Not available on amazon.fr (region=FR).
facetsstring | object listNarrowings taken from a result's facets, e.g. facets=Color:Black. A call that uses facets costs 2 units instead of 1. Not available on amazon.fr (region=FR).
pageinteger1-based page number; each page is charged separately. There is no pageSize (Amazon fixes the count per page, 13-47 in practice) and no cursor — paging is by number.
priceMaxnumber ≥ 0Highest price to return, in decimal major units.
priceMinnumber ≥ 0Lowest price to return, in decimal major units.
ratingMinnumber4 only. Amazon's rating filter offers exactly one threshold, "4 Stars & Up"; any other value is a 400 rather than a silently different search. Not available on amazon.fr (region=FR).
regionenumWhich Amazon marketplace to query, by buyer country: US, CA, MX, BR, FR, IT, ES, NL, SE, TR, AE, SA, IN, JP, SG, AU. Defaults to US. Prices come back in that marketplace's own currency (JP in JPY, FR in EUR). US CA MX BR FR IT ES NL SE TR AE SA IN JP SG AU
sortenumResult ordering: best_match, price_asc, price_desc, newly_listed or avg_review. Defaults to best_match, Amazon's own relevance ordering. best_match price_asc price_desc newly_listed avg_review

같은 파라미터와 모든 응답 타입은 OpenAPI 문서에도 있습니다.

응답

data에 SearchResult를 돌려줍니다. 실제 응답을 줄인 것입니다. 배열은 앞쪽 항목만 남기고 긴 텍스트는 잘랐습니다.

{
  "success": true,
  "data": {
    "marketplace": "amazon",
    "page": {
      "index": 1,
      "size": 0
    },
    "items": [],
    "facets": []
  }
}

에러

상태코드의미
400CATEGORY_NOT_BROWSABLE상품이 없는 탐색용 단계의 카테고리입니다. categories에서 그 하위 카테고리 중 하나를 browse하세요.
400INVALID_PARAMS파라미터가 없거나, 알 수 없거나, 범위를 벗어났습니다. 메시지에 이름이 나옵니다.
401UNAUTHORIZEDx-api-key 헤더가 없거나, 폐기되었거나 알 수 없는 키입니다.
402INSUFFICIENT_BALANCE잔액이 이 호출 비용에 모자랍니다. 대시보드에서 충전하세요.
429MARKETPLACE_SATURATED동시 호출이 너무 많습니다. Retry-After 초만큼 기다린 뒤 다시 시도하세요.
502UPSTREAM_ERROR플랫폼이 쓸 수 없는 응답을 보냈습니다. 간격을 두고 다시 시도하세요.

모든 코드는 Errors에 있습니다. 실패한 호출은 과금되지 않습니다.

가격

가격 호출당 $0.001, 추가 호출마다 $0.001 — 최대 1번 더, 합계 최대 $0.002. brands와 레일 facet만 하나를 더합니다. 둘 중 하나를 쓰면 2단위입니다. 다른 필터는 추가 비용이 없습니다. 정가 기준이며, 하루 1,000회를 넘으면 단가가 내려갑니다.

참고

  • 키워드를 뺀 search와 같은 필터를 받습니다. query는 조용히 무시되지 않고 400입니다. 검색어가 있다면 Search를 사용하세요.
  • categoryId는 browse node입니다 (679416011). Categories에서 얻을 수 있으며, 대분류(department) 단계 아래의 모든 node는 상품을 나열합니다.
  • 응답에는 query 키가 없고, 그 외에는 검색 응답과 완전히 같습니다.

이 페이지 내용