Endpoints

Common endpoints for accessing data through the Storefront REST API

Introduction

All endpoints are relative to our base URL:

https://api.okendo.io/v1/stores/{okendo_user_id}

Substitutions Reference

Throughout this article you will see substitutions enclosed in {} for example {okendo_user_id}. Replace these (including the curly brackets) with the corresponding value:

okendo_user_id: Your Okendo User ID. You can get this information from the Okendo section in the integration settings of the Okendo app.

product_id: A Shopify Product ID.

group_id: An Okendo Group ID or a Shopify Collection ID.

List Reviews

Retrieve a list of published reviews relating to a specific resource.

By Product

GET /products/shopify-{product_id}/reviews

By Store

GET /reviews

By Group

GET /collections/{group_id}/reviews

Query Params

limit: Integer between 1 and 25. Default 25.

orderBy: One of: date desc, date asc, rating desc, rating asc, helpful desc, helpful asc, has_media desc. Default: date desc.

locale: One of the locale query param values below (e.g. locale=es):

Using the locale param requires translation settings to be configured in Okendo Admin.

Review Translations are currently ONLY supported for reviews who's languages were automatically detected and the time of creation/import.

See: https://support.okendo.io/en/articles/9684374-enabling-review-translation-for-multiple-languages

for configuration before use. The translations settings for your review widgets should be configured to "On Load" in your Okendo settings.

locale query param	Language
zh-TW	Chinese (Traditional)
da	Danish
nl	Dutch
en	English
fr	French
de-formal	German - Formal
de-informal	German - Informal
id	Indonesian
it	Italian
ja	Japanese
ko	Korean
pl	Polish
pt-PT	Portuguese
ru	Russian
es	Spanish
sv	Swedish
th	Thai
vi	Vietnamese

Example

List the most recent 10 reviews the store has received:

GET https://api.okendo.io/v1/stores/{okendo_user_id}/reviews?limit=10&orderBy=date%20desc

Get Review Aggregate

Get an aggregate of all the data related to published reviews for a specific resource.

By Product

GET /products/shopify-{product_id}/review_aggregate

By Store

GET /review_aggregate

By Group

GET /collections/{group_id}/review_aggregate

List Review Media

Retrieve a list of published media attached to reviews relating to a specific resource. Ordered by most recent first.

By Product

GET /products/shopify-{product_id}/review_media

By Store

GET /review_media

By Group

GET /collections/{group_id}/review_media

Query Params

limit: Integer between 1 and 25. Default 25.

List Questions & Answers

Retrieve a list of published questions (and corresponding answers) relating to a specific resource. Ordered by most recent first.

By Product

GET /products/shopify-{product_id}/questions

By Store

GET /questions

By Group

GET /collections/{group_id}/questions

Query Params

limit: Integer between 1 and 25. Default 25.