latestSwagger 2.02026-08-172560124.6 KB

6863a5956792

merchants

Retrieves customer reviews for a merchant, specified by reviewId

This endpoint retrieves customer reviews for a particular merchant with rating, description, locale, date & the customer's information.This merchant should be specified by their identifier merchantId, which is mandatory.

Supports pagination via offset & limit parameters in the request.

offset allows skipping the first n reviews. limit makes sure the response contains a maximum of n reviews.

If not supplied, offset will be 0 and limit will be 10

####Response:

  • customer: block contains link to customer's profile image, customer's first name & first letter of customer's last name.
  • rating: a value between 1 and 6, where 1 represents the worst rating and 6 represents the best.
  • description: the review description entered by the customer.
  • locale: represents the language settings of the customer, in the format: <language code>_<country code>
  • date: represents the date of the review, with the format: yyyy-MM-dd

Example curl:

curl https://{host}/v{X}/merchants/15/reviews?offset=10&limit=5

Example response:

{
   reviews: [
     {
           customer: {
                firstName: "Hans",
                lastName: "W",
                profileImage: {
                    url: "https://www..."
                },
           },
           rating: 1,
           description: "Foo bar",                
           locale: "de_DE",
           date: "2017-07-21"
     }
   ],
   offset: 10,
   limit: 5,
   size: 1
}
get/v1/merchants/{merchantId}/reviews

Path parameters

merchantIdinteger required

Query parameters

offsetinteger

Skip first n reviews

limitinteger

Max number of reviews to be retrieved

Response

Review response

sizeinteger
offsetinteger
limitinteger