UNunified
commerce
review

List all reviews

Changed on

Returns a list of CommerceReviews. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/commerce/{connection_id}/review

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

item_idstring

The item ID to filter by (reference to CommerceItem)

location_idstring

The location ID to filter by (reference to CommerceLocation)

contact_idstring

The contact ID to filter by (reference to AccountingContact)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

item_idstring

Reference to the product being reviewed (reference to CommerceItem)

item_variant_idstring

Optional reference to specific variant if applicable (reference to CommerceCommerceItemvariant)

location_idstring

(reference to CommerceLocation)

ratingnumber

1-5 rating

titlestring
contentstring
author_namestring
author_emailstring
author_avatar_urlstring
author_locationstring
verified_purchaseboolean
helpful_votesnumber
unhelpful_votesnumber
status'PENDING' | 'APPROVED' | 'REJECTED' | 'SPAM'
is_verifiedboolean
is_featuredboolean
is_publicboolean
urlstring
rawobject

Original review data from source platform

Changes