🔒

Requires write_comments access scope. More access scope

The Batch Create Comment API allows users to create multiple comments for products in a single request. This is especially useful for bulk operations, such as importing customer reviews or adding product feedback in batch.## Use Cases

1. Import multiple product reviews at once for efficient management.
2. Add bulk feedback or testimonials during product updates.
3. Simplify large-scale operations, such as migrating comments to a new store.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Body Parameters

Response Explanation

Successful Response

Error Details (error_info Object)

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Request Examples

curl --request POST \
     --url https://{shopdomain}.myshoplaza.com/openapi/2022-01/comments/batch \
     --header 'accept: application/json' \
     --header 'access-token: YOUR_ACCESS_TOKEN' \
     --header 'content-type: application/json' \
     --data '{
       "comments": [
         {
           "product_id": "33f1b4f6-9474-4e6c-9a3f-676a420ea8bb",
           "username": "Joey",
           "star": 5,
           "image": "http://abc.com/img.jpg;http://def.com/img.jpg",
           "like": 123,
           "created_at": "2019-07-10 15:00:00",
           "content": "Cheap but beautiful",
           "country": "CN"
         },
         {
           "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
           "username": "Alice",
           "star": 4,
           "image": "",
           "like": 45,
           "created_at": "2020-01-01 12:00:00",
           "content": "Great product!",
           "country": "US"
         }
       ]
     }'

Success Response Example

{
  "success_count": 2,
  "error_count": 0,
  "error_info": []
}
}

Error Response Example

{
  "error": "store is not active"
  }
}

Error Details