Apinoa Docs

Reviews

스토어가 사용하는 리뷰 앱에서 Shopify 상품의 리뷰를 가져옵니다.

원본 .mdx 보기
GET | POST /v1/shopify/reviews

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

요청

curl "https://gateway.apinoa.com/v1/shopify/reviews?id=www.orthofeet.com%2Fcoral-black" \
  -H "x-api-key: $APINOA_API_KEY"

파라미터

파라미터타입필수설명
idstring예The composite Shopify shop/handle — the same id product takes, not a global identifier. This is the one Shopify operation whose cost varies: a first page can cost more than 1, while a page fetched with cursor costs 1.
cursorstringOpaque cursor from the previous response; the only paging knob that works on every shop, and it wins if page is sent too. A page fetched with a cursor costs 1.
pageinteger1-based starting page. Not every shop supports jumping to a page number; cursor works on every shop, so prefer it for paging.

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

응답

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

{
  "success": true,
  "data": {
    "marketplace": "shopify",
    "productId": "www.orthofeet.com/coral-black",
    "page": {
      "index": 1,
      "size": 30,
      "total": 990
    },
    "reviews": [
      {
        "id": "df4c25ec-c5c8-41e5-8fd2-8c72cec3ab88",
        "author": "Karen Michel",
        "rating": 3,
        "title": "Not as expected",
        "body": "I needed good shoes to take on a tour in italy. I used these shoes thinking they would support my feet. But they did no…",
        "date": "2026-10-24T15:13:07.824Z",
        "verified": true,
        "helpfulCount": 0,
        "variant": "Coral - Beige Leopard",
        "images": []
      },
      {
        "id": "0788f651-a9a4-4c14-9c4d-25ca08b88951",
        "author": "Anna Prigozhin",
        "rating": 5,
        "body": "Coral - White",
        "date": "2026-10-24T15:05:48.452Z",
        "verified": true,
        "helpfulCount": 0,
        "variant": "Coral - White",
        "images": []
      }
    ],
    "summary": {
      "average": 4.1,
      "count": 38998,
      "distribution": {
        "1": 11,
        "2": 6,
        "3": 9,
        "4": 10,
        "5": 64
      }
    },
    "grouped": true,
    "cursor": "eyJhIjoianVkZ2VtZSIsImkiOnsibXlzaG9waWZ5Ijoib3J0aG9mZWV0Lm15c2hvcGlmeS5jb20iLCJwcm9kdWN0SWQiOiI2NzAyNDYxNzQ4OCJ9LCJjIjo…"
  }
}

에러

상태코드의미
400INVALID_CURSOR이 오퍼레이션이 돌려준 cursor가 아닙니다. cursor 없이 처음부터 다시 호출하세요.
400INVALID_PARAMS파라미터가 없거나, 알 수 없거나, 범위를 벗어났습니다. 메시지에 이름이 나옵니다.
401UNAUTHORIZEDx-api-key 헤더가 없거나, 폐기되었거나 알 수 없는 키입니다.
402INSUFFICIENT_BALANCE잔액이 이 호출 비용에 모자랍니다. 대시보드에서 충전하세요.
429MARKETPLACE_SATURATED동시 호출이 너무 많습니다. Retry-After 초만큼 기다린 뒤 다시 시도하세요.
501REVIEWS_UNREACHABLE스토어에 리뷰가 표시되지만 하나도 읽을 수 없었습니다.
501REVIEW_APP_UNSUPPORTED스토어의 리뷰가 이 API가 아직 읽지 않는 앱에서 제공됩니다.
502UPSTREAM_ERROR플랫폼이 쓸 수 없는 응답을 보냈습니다. 간격을 두고 다시 시도하세요.

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

가격

가격 호출당 $0.001, 추가 호출마다 $0.001 — 최대 6번 더, 합계 최대 $0.007. 첫 페이지는 보통 기본보다 1단위 더 들고, cursor 페이지는 기본만 듭니다. 정가 기준이며, 하루 1,000회를 넘으면 단가가 내려갑니다.

참고

  • 다음 페이지는 cursor를 사용하세요. page는 모든 스토어에서 지원되지는 않지만 cursor는 항상 동작합니다. 첫 페이지는 보통 기본보다 1단위 더 들고, cursor 페이지는 기본만 듭니다.
  • 리뷰가 없는 것도 답입니다. 리뷰가 없는 상품은 reviews: []와 page.total: 0으로 200을 돌려주며, 0은 실제로 0일 때만 보냅니다. 텍스트 없는 별점은 리뷰 0개로 셉니다.
  • 501은 리뷰가 있지만 읽을 수 없었다는 뜻입니다 — 의도적으로 404도, 빈 목록도 아닙니다.
  • 리뷰는 흔히 묶여 있습니다. 스토어는 한 색상의 페이지에 상품군 전체의 리뷰로 응답할 수 있습니다. 상품별 평점을 계산하기 전에 grouped를 확인하세요.

이 페이지 내용