Reviews

Endpoints related to Okendo Reviews and review groups

Reviews

List Reviews

get

Returns a list of Reviews for the requested store

Authorizations

AuthorizationstringRequired

Query parameters

limitinteger · int32Optional

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

Example: 25

lastEvaluatedstringOptional

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

orderBystringOptional

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

Example: date desc

statusstring · enumOptional

The moderation status of the review.

Example: approvedPossible values:

Responses

200

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

application/json

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

get

/reviews

GET /enterprise/reviews HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

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

Retrieve a Review

get

Authorizations

AuthorizationstringRequired

Path parameters

reviewIdstring · uuidRequired

The ID of the Review to retrieve.

Responses

200

A Review object

application/json

401

Authentication credentials are missing or incorrect.

404

The requested resource could not be found.

application/json

get

/reviews/{reviewId}

GET /enterprise/reviews/{reviewId} HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

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

Update a Review

put

Authorizations

AuthorizationstringRequired

Path parameters

reviewIdstring · uuidRequired

The ID of the Review to update.

Body

statusstringRequired

The moderation status of the review.

Example: approved

Responses

200

A Review object

application/json

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

404

The requested resource could not be found.

application/json

put

/reviews/{reviewId}

PUT /enterprise/reviews/{reviewId} HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "status": "approved"
}

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

Reply to a Review

post

Authorizations

AuthorizationstringRequired

Path parameters

reviewIdstring · uuidRequired

The ID of the Review to reply to.

Body

shouldEmailReplybooleanOptional

Whether the Customer should be notified of the reply via email.

Example: true

Responses

200

The updated Review with the reply included.

application/json

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

404

The requested resource could not be found.

application/json

post

/reviews/{reviewId}/reply

POST /enterprise/reviews/{reviewId}/reply HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "reply": {
    "body": "Thank you for your feedback!",
    "isPrivate": false
  },
  "shouldEmailReply": true
}

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

Groups

Create a Shopify backed group and return the group created

post

Authorizations

AuthorizationstringRequired

Body

namestringRequired

The name of the group.

isAutoAssignProductsEnabledbooleanRequired

Indicates if the products in the group are automatically assigned to show reviews from other products within the same group.

shopifyCollectionIdstringRequired

The ID of Shopify collection that will be used to create the group.

Example: 123456789

Responses

200

An object containing the group that was just created.

application/json

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

409

This response is sent when a request conflicts with the current state of the server.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

post

/groups

POST /enterprise/groups HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "name": "text",
  "isAutoAssignProductsEnabled": true,
  "shopifyCollectionId": 123456789
}

{
  "group": {
    "shopifyCollectionId": 123456789,
    "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2022-01-18T02:21:20.380Z",
    "isAutoAssignProductsEnabled": true,
    "name": "text"
  }
}

PreviousEndpoints NextLoyalty

Last updated 3 months ago