getFeedback delivers the reviews for a shop, including the rating, the text the clients sent and comments from the shop owners.
|
PRE-CONDITIONS | |||
Parameter | Description | Example | mandatory |
auth | Interface-ID and Interface-Password, separated by pipe (|) | ABC|XYZ | required |
interface_id | Can be used together with interface_pw instead of auth | ABC | optional |
interface_pw | Can be used together with interface_id instead of auth | XYZ | optional |
version | Script-Version. For self-build. Precede with ‘cust-’ | cust-1.0.0 | required |
type | Output type. Either “csv” (default) or “json” | csv | optional |
charset | Character encoding. Either “iso” (default) or “utf-8”. For non-ISO languages (Russian, Chinese, etc.) and for all JSON utf-8 must be used. | utf-8 | optional |
filter | Here you can filter for [all], [positive] and [critical] reviews. [all] is the default. [critical] will return reviews with less than 4 stars [positive] will return reviews with more than 3 stars | all | optional |
caching | You may use caching to obtain faster results. Possible values are: [none], [short], [middle] [long] and ([verylong]). Cachetime in seconds: none:0, short:120, middle:300, long:600, verylong:3600 | short | optional |
range | You may set a time range from which to request feedback: Possible values: [all], [1m], [3m], [6m], [1y], “m”indicates month(s) “y”indicates year [all] is the default | 6m | optional |
fields | allows you to specify which columns should be returned. Content of fields must be a comma-separated string (no spaces). You can also use this to sort the fields in a specific order. Any combination of the following fields is valid : [date] [order_id] [rating] [feedback] [comment] [shop_review_title] [has_email] additional fields for AFNOR compliance : [order_day] [firstname] [lastname] [screenname] [client_id] default : [date] [order_id] [rating] [feedback] [comment] Please note that results are sorted by date, so leaving out [date] will affect the order of results as well as the range parameter. | date,feedback,rating | optional |
POST-CONDITIONS | |
Parameter | Description |
submitted | UNIX timestamp of when the feedback was submitted |
order_id | Order/ transaction ID of order |
rating | 1 to 5 stars |
review | Feedback text |
comment | Feedback Comments (empty if there are no comments) |
Only if has_email has been set to true. ‘yes’ if email address (and thus dialog) is available, ‘no’ if not. |
*csv delimiter is comma and quotes are used as enclosures
**index names are only displayed in json
ERRORS | ||
CODE | Name | Description |
ERROR: | Interface ID or password not transmitted | |
Interface ID or password is not valid. | ||
Filter is not valid. Possible options: ([all]), [positive] and [critical] | ||
Type is not valid. Possible options: ([csv], [json]). | ||
Charset is not valid. Possible options: [iso] and ([utf-8]). | ||
Caching is not valid. Possible options: [none], [short], [middle], [long] and ([verylong]) | ||
state is not valid. Possible options: [published]. |