Shulex VOC API English Version

Create custom VOC report

POST/voc/custom/reports/

Create VOC report by user provided reviews

Request

Header Params

X-Token

string

required

API Key

Example:

42e9fb1c94c842cd9495c812a4c8fe05

category

string

required

Amazon category path, multi-level categories separated by :, for example: Patio, Lawn & Garden:Patio Furniture & Accessories:Umbrellas & Shade:Shade Sails

Example:

Patio, Lawn & Garden:Patio Furniture & Accessories:Umbrellas & Shade:Shade Sails

reviews

array [object {2}]

required

Review information list

<= 1000 items

stars

string

optional

stars

message

string

required

review message

{
  "category": "Patio, Lawn & Garden:Patio Furniture & Accessories:Umbrellas & Shade:Shade Sails",
  "reviews": [
    {
      "message": "Not worth your money - only had up for one week and it ripped.  Our coolaroo lasted over 10 years. Unfortunately they no longer make the size we need."
    },
    {
      "message": "Awesome buy. Very tough material and several sizes to choose from."
    },
    {
      "message": "I was disappointed . There were no attached clips. I had one before and it had the built in clips. I just hung it up.  This sunshade  was a lot of money and I’m buying clips to"
    },
    {
      "message": "I ordered this to use for coverage on a 16 x 16 full-sun deck. Sizing chart indicated to order it big enough to leave 6 on each side so I ordered 15 x 15. The sail was up only 2 days before it started sagging due to stretching. Nothing in the size guide indicated to order anything smaller due to stretch. Please update the size guide!"
    }
  ]
}

Request samples

Responses

成功(200)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer

required

Result code

msg

string

optional

Error message

data

object

optional

reportId

string

required

Report ID

{
  "code": 200,
  "data": {
    "reportId": "2134"
  }
}

Last modified: 1 年前