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

JavaScriptCurlPython

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

Response

200400

{
  "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-11-21T07:08:14.588Z",
      "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-11-21T07:08:14.588Z",
        "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"
}

Reply to a Review

POSThttps://api.okendo.io/enterprise/reviews/{reviewId}/reply

Path parameters

reviewId*string (uuid)

The ID of the Review to reply to.

Body

application/json

reply*object

shouldEmailReplyboolean

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

Example: true

Response

200400401404

The updated Review with the reply included.

Body

application/json

reviewobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.okendo.io/enterprise/reviews/{reviewId}/reply', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reply": {
        "body": "Thank you for your feedback!"
      }
    }),
});
const data = await response.json();

Response

200400404

{
  "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": false,
    "dateCreated": "2024-11-21T07:08:14.588Z",
    "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-11-21T07:08:14.588Z",
      "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"
  }
}

Loyalty

Retrieve basic details about a Loyalty Customer

GEThttps://api.okendo.io/enterprise/loyalty/customers

Query parameters

Response

200401403404

An object containing basic details about a Loyalty Customer.

Body

application/json

loyaltyCustomer*object

Request

JavaScriptCurlPython

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

Response

200403404

{
  "loyaltyCustomer": {
    "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
    "minimumVipTierName": "text",
    "points": {
      "balance": 0
    },
    "status": "pending",
    "vipTierName": "text"
  }
}

List ways to earn loyalty points

Lists the available ways to earn loyalty points. If a Loyalty Customer is specified, this returns ways of earning and amounts tailored to that customer.

GEThttps://api.okendo.io/enterprise/loyalty/earning_rules

Query parameters

Response

200401403404

An object containing a list of earning rules.

Body

application/json

rulesarray of one of

Request

JavaScriptCurlPython

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

Response

200403404

{
  "rules": [
    {
      "type": "fixed-amount",
      "amount": 0
    }
  ]
}

Trigger a custom earning rule for a Loyalty Customer

POSThttps://api.okendo.io/enterprise/loyalty/earning_transactions

Body

application/json

actionId*string

The action ID of the custom earning rule.

Example: "k2d6ne"

customerIdentifier*object

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

objectobject

valuenumber

The value to be multiplied with the 'points per' value. Required for Custom Points Per Value Rules.

Example: 10

Response

200400401403404422

The transaction was successfully created and the Customer was awarded points based on the configured earning rule.

Body

application/json

pointsEarnedinteger (int64)

loyaltyCustomerobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.okendo.io/enterprise/loyalty/earning_transactions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "actionId": "k2d6ne",
      "customerIdentifier": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }),
});
const data = await response.json();

Response

200400403404422

{
  "loyaltyCustomer": {
    "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
    "points": {
      "balance": 0
    }
  }
}

Adjust the points balance of a Loyalty Customer

POSThttps://api.okendo.io/enterprise/loyalty/adjustment_transactions

Body

application/json

customerIdentifier*object

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

objectobject

amount*integer (int32)

The number of points by which the customer's points balance is to be adjusted. Specify either a positive number to add points or a negative number to remove points.

Example: 10

internalReasonstring

Description of the transaction which is displayed to the store owner.

Example: "Gifted points due to bad shipping experience"

notificationTextstring

Description of the transaction which is displayed to the Customer.

Example: "Gifted Points"

Response

200400401403404422

The transaction was successfully created and the Loyalty Customer's points balance was updated.

Body

application/json

loyaltyCustomerobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.okendo.io/enterprise/loyalty/adjustment_transactions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerIdentifier": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "amount": 10
    }),
});
const data = await response.json();

Response

200400403404422

{
  "loyaltyCustomer": {
    "points": {
      "balance": 0
    }
  }
}

Set a Loyalty Customer's minimum VIP Tier

POSThttps://api.okendo.io/enterprise/loyalty/customer_minimum_vip_tiers

Body

application/json

customerIdentifier*object

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

objectobject

minimumVipTierName*nullable string

The name of the VIP Tier, or null to remove a previously configured minimum VIP Tier.

Example: "Silver"

Response

200400401403404422

The Loyalty Customer's minimum VIP Tier was updated, in addition to any resultant change to the current VIP Tier.

Body

application/json

minimumVipTierNamestring

vipTierNamestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.okendo.io/enterprise/loyalty/customer_minimum_vip_tiers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerIdentifier": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "minimumVipTierName": "Silver"
    }),
});
const data = await response.json();

Response

200400403404422

{
  "minimumVipTierName": "text",
  "vipTierName": "text"
}

Customers

Look up a Customer's ID by email address

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

Body

application/json

email*string (email)

The email address of the Customer to look up.

Example: "[e-mail]"

Response

200400401404

A Customer was found matching the provided email address.

Body

application/json

customerIdstring (uuid)

Request

JavaScriptCurlPython

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

Response

200400404

{
  "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.

Example: "2022-01-18T02:21:20.380Z"

dateLastActivestring (date-time)

The date of the Customer's most recent action.

Example: "2023-02-14T04:34:21.390Z"

emailstring (email)

The email address of the customer.

Example: "[e-mail]"

givenNamestring

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

Example: "Jane"

familyNamestring

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

Example: "Smith"

avatarUrlstring (uri)

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

Example: "https://via.placeholder.com/160/1d2135/00eab6"

locationobject

Request

JavaScriptCurlPython

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

Response

200404

{
  "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

JavaScriptCurlPython

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

Response

200400

{
  "profiles": [
    {
      "namespace": "okendo-general",
      "properties": [
        {
          "name": "Given Name",
          "value": "Jane",
          "valueType": "string",
          "date": "2024-11-21T07:08:14.588Z"
        }
      ]
    }
  ],
  "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

JavaScriptCurlPython

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

Response

200400

{
  "activities": [
    {
      "activityId": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "okendo-general",
      "date": "2024-11-21T07:08:14.588Z",
      "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

name*string

The name of the group.

isAutoAssignProductsEnabled*boolean

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

shopifyCollectionId*string

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

Example: 123456789

Response

200400401409422

An object containing the group that was just created.

Body

application/json

groupobject

Request

JavaScriptCurlPython

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

Response

200400409422

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