Quick Start

The Merchant REST API API is not intended for client-side use.

For public and client-side use, see the Storefront REST API.

Get Your Credentials

Your API requests are authenticated using your Okendo User ID and an API Key. You can get these details from the integration settings section of the Okendo app.

Make Your First Request

To make your first request, send an authenticated request to the /reviews endpoint. This will fetch some of your published reviews.

List Reviews

Returns a list of Reviews for the requested store

get

/reviews

Authorizations

Query parameters

limitinteger · int32

A limit on the number of items returned. Between 1 and 100. Default 25.

Example: 25

lastEvaluatedstring

The URL-encoded JSON object representing the cursor for the next page of results.

orderBystring

The sort order of the reviews. Format: '(date|rating) (asc|desc)'. Default 'date desc'

Example: date desc

statusstring · enum

The moderation status of the review.

Example: approved

Options: approved, pending, rejected

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.okendo.io/enterprise/reviews' \
  --header 'Authorization: Basic username:password'

200

400

401

200

{
  "nextUrl": "https://example.com",
  "reviews": [
    {
      "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
      "reviewId": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "shopify-123456789",
      "body": "Great quality! Great price! Would buy again!",
      "containsProfanity": true,
      "dateCreated": "2025-02-21T18:15:36.042Z",
      "helpfulCount": 1,
      "isRecommended": true,
      "productName": "MacBook Pro",
      "rating": 5,
      "title": "Love these shoes!",
      "unhelpfulCount": 1,
      "variantId": "1234567890",
      "variantName": "MacBook Pro - 15 Inch",
      "sentiment": "positive",
      "status": "approved",
      "tags": [
        "Support Needed",
        "Favourite"
      ],
      "order": {
        "orderId": "123456789",
        "orderNumber": "#OKRXXXX"
      },
      "reply": {
        "body": "<p><b>Thanks</b> for your review</p>",
        "dateCreated": "2025-02-21T18:15:36.042Z",
        "rawBody": "*Thanks* for your review",
        "isPrivate": true
      },
      "reward": {
        "description": "$10 off your next order over $40",
        "integration": "loyaltyLion",
        "value": "OKRX-XXXXX-XXXX",
        "isCouponUpgrade": true,
        "type": "coupon"
      },
      "attributesWithRating": [
        {
          "minLabel": "Too Small",
          "midLabel": "Just Right",
          "maxLabel": "Too Big",
          "title": "Sizing",
          "value": 1,
          "type": "centered-range"
        }
      ],
      "media": [
        {
          "streamId": "123e4567-e89b-12d3-a456-426614174000",
          "fullSizeUrl": "https://example.com",
          "largeUrl": "https://example.com",
          "thumbnailUrl": "https://example.com",
          "isHidden": true,
          "type": "image"
        }
      ],
      "productAttributes": [
        {
          "title": "Pros",
          "type": "drop-down",
          "value": "Powerful"
        }
      ],
      "reviewer": {
        "avatarUrl": "https://example.com",
        "displayName": "Tim C.",
        "email": "[e-mail]",
        "isVerified": true,
        "name": "Tim Cook",
        "socialConnection": "facebook",
        "verifiedStatus": "Verified Buyer",
        "location": {
          "zoneCode": "NSW",
          "country": {
            "code": "au",
            "name": "Australia"
          }
        },
        "attributes": [
          {
            "title": "Pros",
            "type": "drop-down",
            "value": "Powerful"
          }
        ]
      }
    }
  ]
}

An object containing a list of Reviews and a relative link to the next page of results if available.

To make the request, use a networking client of your choice or follow these examples:

cURL

curl https://api.okendo.io/enterprise/reviews -u <okendo_user_id>:<api_key>

Node.js

const https = require('https');

https.get('https://api.okendo.io/enterprise/reviews', { auth: '<okendo_user_id>:<api_key>' }, res => {
    let body = '';
    res.on('data', chunk => body += chunk);
    res.on('end', () => {
        const response = JSON.parse(body);
        console.log(response.reviews);
    });
});