Shulex VOC API English Version
    Shulex VOC API English Version
    • Submit Amazon product review information Task
      POST
    • Get Amazon product review information
      GET
    • Create Amazon VOC report
      POST
    • Get Amazon VOC report result
      GET
    • Create custom VOC report
      POST
    • Get custom VOC report result
      GET

      Get Amazon product review information

      GET
      /voc/{asin}/reviews
      Get Amazon product review information. Before calling this API, please submit the task of obtaining Amazon product review information API.

      Request

      Path Params
      asin
      string 
      required
      Amazon product ASIN
      Example:
      B07ZF8T63K
      Query Params
      countryCode
      string 
      required
      Amazon site name, optional values: US, UK, DE, FR, IT, CA, ES, JP
      Example:
      US
      includeVariants
      string 
      optional
      Whether to include all variant data, the default value is false
      Example:
      true
      startDate
      string 
      optional
      Reviews start date, date format yyyy-MM-dd, query all comments by default
      Example:
      2023-09-30
      pageNo
      integer 
      optional
      Current page number, default value is 1
      Example:
      1
      pageSize
      integer 
      optional
      The number of reviews obtained per page. The default value is 50 and the maximum value is 50.
      Example:
      50
      orderBy
      string 
      optional
      review result order field, currently it's value can only be 'reviewDate', default value is reviewDate
      Example:
      reviewDate
      orderType
      string 
      optional
      review result order type, it's value can only be 'desc' or 'asc, default value is desc
      Example:
      desc
      Header Params
      X-Token
      string 
      required
      API Key
      Example:
      42e9fb1c94c842cd9495c812a4c8fe05

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://apps.voc.ai/api_v2/datahub//voc/B07ZF8T63K/reviews?countryCode=US&includeVariants=true&startDate=2023-09-30&pageNo=1&pageSize=50&orderBy=reviewDate&orderType=desc' \
      --header 'X-Token: 42e9fb1c94c842cd9495c812a4c8fe05'

      Responses

      🟢200成功
      application/json
      Body
      code
      integer 
      required
      Result code
      msg
      string 
      optional
      Error message
      data
      object 
      optional
      Result data
      finish
      boolean 
      required
      Review available
      total
      integer 
      required
      Total reviews
      pageNo
      integer 
      required
      Current page no
      pageSize
      integer 
      required
      The paging size
      list
      array [object {17}] 
      optional
      Reviews list
      Example
      {
          "code": 200,
          "msg": "success",
          "data": {
              "finish": true,
              "total": 22940,
              "list": [
                  {
                      "asin": "B0B4ZQXGK9",
                      "authorName": "test",
                      "content": "I liked the size and the sturdiness of each one. The color was just beautiful. First time buying luggage like these and have no regrets.",
                      "earlyReviewer": false,
                      "productLink": "https://www.amazon.com/dp/B0B4ZQXGK9",
                      "reviewDate": 1707177600000,
                      "reviewId": "R3FNZ6I50J5UIZ",
                      "reviewLink": "https://www.amazon.com/gp/customer-reviews/R3FNZ6I50J5UIZ",
                      "sku": "Size:4 piece set|Color:PP-Aqua Blue",
                      "star": 5,
                      "title": "Sturdy"
                  }
              ],
              "pageNo": 1,
              "pageSize": 10
          }
      }
      Previous
      Submit Amazon product review information Task
      Next
      Create Amazon VOC report
      Built with