Endpoints

Reviews

List Reviews

Returns a list of Reviews for the requested store

GEThttps://api.okendo.io/enterprise/reviews

Query parameters

Response

200400401

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

Body

application/json

reviewsarray of object

nextUrlstring (uri)

Request

JavaScriptCurl

const response = await fetch('https://api.okendo.io/enterprise/reviews', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false,
      "dateCreated": "2024-05-08T03:34:32.998Z",
      "isRecommended": false,
      "media": [
        {
          "streamId": "123e4567-e89b-12d3-a456-426614174000",
          "fullSizeUrl": "https://example.com",
          "largeUrl": "https://example.com",
          "thumbnailUrl": "https://example.com",
          "type": "image",
          "isHidden": false
        }
      ],
      "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": "2024-05-08T03:34:32.998Z",
        "rawBody": "*Thanks* for your review",
        "isPrivate": false
      },
      "reviewer": {
        "attributes": [
          {
            "title": "Pros",
            "type": "drop-down",
            "value": "Powerful"
          }
        ],
        "avatarUrl": "https://example.com",
        "displayName": "Tim C.",
        "email": "[e-mail]",
        "isVerified": false,
        "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": false
      },
      "sentiment": "positive",
      "status": "approved",
      "tags": [
        "Support Needed",
        "Favourite"
      ],
      "title": "Love these shoes!",
      "variantId": "1234567890",
      "variantName": "MacBook Pro - 15 Inch"
    }
  ],
  "nextUrl": "https://example.com"
}

Customers

Look up a Customer's ID by email address

POSThttps://api.okendo.io/enterprise/customer_lookup

Body

application/json

emailstring (email)

The email address of the Customer to look up.

Response

200400401404

A Customer was found matching the provided email address.

Body

application/json

customerIdstring (uuid)

Request

JavaScriptCurl

const response = await fetch('https://api.okendo.io/enterprise/customer_lookup', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Retrieve basic details about a Customer

GEThttps://api.okendo.io/enterprise/customers/{customerId}

Path parameters

customerId*string (uuid)

The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.

Response

200401404

An object containing basic details about a Customer.

Body

application/json

dateFirstActivestring (date-time)

The date of the Customer's first action.

dateLastActivestring (date-time)

The date of the Customer's most recent action.

emailstring (email)

The email address of the customer.

givenNamestring

The given name of the customer. Often also known as the first name.

familyNamestring

The family name of the customer. Often also known as the last name.

avatarUrlstring (uri)

The URL of the Customer's current avatar / profile picture.

locationobject

Request

JavaScriptCurl

const response = await fetch('https://api.okendo.io/enterprise/customers/{customerId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "dateFirstActive": "2022-01-18T02:21:20.380Z",
  "dateLastActive": "2023-02-14T04:34:21.390Z",
  "email": "[e-mail]",
  "givenName": "Jane",
  "familyName": "Smith",
  "avatarUrl": "https://via.placeholder.com/160/1d2135/00eab6",
  "location": {
    "country": "Australia",
    "zoneCode": "NSW"
  }
}

List Customer Profiles and their included properties

A Customer Profile is a collection of data points (grouped by namespace) about a specific Customer.

GEThttps://api.okendo.io/enterprise/customers/{customerId}/profiles

Path parameters

customerId*string (uuid)

The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.

Query parameters

Response

200400401

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

Body

application/json

profilesarray of object

nextUrlstring (uri)

Request

JavaScriptCurl

const response = await fetch('https://api.okendo.io/enterprise/customers/{customerId}/profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "profiles": [
    {
      "namespace": "okendo-general",
      "properties": [
        {
          "name": "Given Name",
          "value": "Jane",
          "valueType": "string",
          "date": "2024-05-08T03:34:32.998Z"
        }
      ]
    }
  ],
  "nextUrl": "https://example.com"
}

List Customer Activities

A Customer Activity is an action that the Customer has taken or an action that relates to the Customer.

GEThttps://api.okendo.io/enterprise/customers/{customerId}/activities

Path parameters

customerId*string (uuid)

The ID of the Customer to retrieve. Use the /customer_lookup endpoint to get the Customer's ID.

Query parameters

Response

200400401

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

Body

application/json

activitiesarray of object

nextUrlstring (uri)

Request

JavaScriptCurl

const response = await fetch('https://api.okendo.io/enterprise/customers/{customerId}/activities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "activities": [
    {
      "activityId": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "okendo-general",
      "date": "2024-05-08T03:34:32.998Z",
      "title": "Review Submitted"
    }
  ],
  "nextUrl": "https://example.com"
}

Groups

Create a Shopify backed group and return the group created

POSThttps://api.okendo.io/enterprise/groups

Body

application/json

namestring

The name of the group.

isAutoAssignProductsEnabledboolean

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

shopifyCollectionIdstring

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

Response

200400401409422

An object containing the group that was just created.

Body

application/json

groupobject

Request

JavaScriptCurl

const response = await fetch('https://api.okendo.io/enterprise/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "group": {
    "shopifyCollectionId": 123456789
  }
}