Reviews

This endpoint retrieves reviews from various sources such as store, products and more.

Payload

reviews.payload

per_page

number

required

The maximum number of items to return per page

Default:

type

enum<string>

required

The review's source, which could be one of the allowed enum values

Allowed values:

allstorecategoriesproductsjson

items

array[number]

required

The response data. If json is selected, a payload must be passed in items.

Response

Success

reviews.response.success

status

number

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array [object {17}]

required

rating

number

required

Review rating value

content

string

required

Review content

status

string

required

Review status

created_at

object

required

Review creation date

replies

array [object]

required

Review replies

text

string

required

Alias for the content variable

type

string

required

Review type

avatar

string

required

Reviewer avatar

name

string

required

Reviewer name

stars

number

required

Review stars

is_pending

boolean

required

Whether or not the review is pending

has_order

boolean

required

Whether or not the review is associated with an order

kind

enum<string>

required

Review Source

Allowed values:

storepageshipping

session_id

string

required

Reviewer Session ID

customer_id

number

required

Reviewer Customer ID

city

string

required

Reviewer City

date

string

required

Review Date

Usage

The method getReviews takes in 3 parameters: The maximum number of items to return per page per_page, The review's source, type, which could be one of the allowed enum values, as well as items, which is the response data.

Events

The menu process may trigger two events during the menu process, reviewsFetched and reviewsFetchFailed.

reviewsFetched

This event will be triggered when the reviews are successfully fetched.

reviewsFetchFailed

This event will be triggered if there is an error during the fetching process.

Payload#

Response#

Usage#

Events#

reviewsFetched#

reviewsFetchFailed#

Payload

Response

Usage

Events

reviewsFetched

reviewsFetchFailed