Request parameter

Brief description  

Value

Required or optional

Default 

Authentication required 

merchant_

identifier

Unique identifier for the merchant account.

string

Required

None

No

tags

Filter for reviews with corresponding tags.

string

Optional

None

No

date_time

Filter reviews to those created on a specified UTC date / time. 

string

Optional

None

No

updated_date_

time

Filter reviews to those updated on a specified UTC date / time.

string

Optional

None

No

since_period

Filter reviews to those created during the specified period. 

enum

Optional

year

No

since_updated_

period

Filter reviews to those updated during the specified period. 

enum

Optional

year

No

origin

Defines the domain name of the web page calling the Reviews API feed.

string

Optional but required when using multiple domains to call the same reviews API feed

None

No

id

Filter reviews based on the feedback id.

string

Optional

None

No

parent_product_

sku

Filter for product reviews assigned to the specified parent product search code.

string

Optional for:
mode = all
mode = service
mode = nps
Required for:
 mode = product (if product_sku is not used)

None

No

product_sku

Filter for product reviews assigned to the specified product search code.

string

Optional for:
mode = all
mode = service
mode = nps
Required for:
 mode = product (if parent_product_sku is not used)

None

No

customer_

reference

Filter for reviews from a specific customer based on a unique customer reference.

string

Optional

None

Yes

customer_email

Filter for reviews from a specific customer email. 

string

Optional

None

Yes

order_reference

Retrieve the feedback relating to a specific order. 

string

Optional

None

Yes

rating

Defines the number of stars or the NPS score that the reviews should have to be included in the feed.

string

Optional

None

No

children

Specified if feedback from child account should be included in the result set.

enum

Optional

include 

No

media

Specifies filters applied to feedback with associated media. 

enum

Optional

include

No

empty_product_

comments

Specifies how product reviews with no comments should be handled.

enum

Optional

default

No

unanswered_

feedback

Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours. 

enum

Optional

include 

No

full_thread

Specifies whether subsequent exchanges between the customer and merchant should be included in the response. 

enum

Optional

exclude

No

sort

Dictates the fields upon which sorting can be applied. 

enum 

Optional

updated_date  

No

page_size

The number of reviews to return per page, limited to 100. 

string

Optional

20

No

page

The page number to return reviews for.

string

Optional

1

No

fields

Limit the response to include certain fields.

string

Optional

None

No

enhanced_

insight

Only functional if the account has Smart Themes enabled.
 Specifies if enhanced insight data should be included in the API response.

enum

Optional

exclude

No

feature

Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter.
Filter reviews to those that include the associated feature.

string

Optional for:
mode = service
mode = product
Unsupported for:
mode = all
 mode = nps

None

No