Endpoints

Okendo

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

cURL

JavaScript

Python

HTTP

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

200

400

401

{
  "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:18:18.577Z",
      "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:18:18.577Z",
        "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": "hello@example.com",
        "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.

Reply to a Review

post

/reviews/{reviewId}/reply

Authorizations

Path parameters

reviewIdstring · uuidrequired

The ID of the Review to reply to.

Body

shouldEmailReplyboolean

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

Example: true

replyobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/reviews/{reviewId}/reply' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"shouldEmailReply":true,"reply":{"body":"Thank you for your feedback!","isPrivate":false}}'

200

400

401

404

{
  "review": {
    "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:18:18.577Z",
    "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:18:18.577Z",
      "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": "hello@example.com",
      "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"
        }
      ]
    }
  }
}

The updated Review with the reply included.

Retrieve basic details about a Loyalty Customer

get

/loyalty/customers

Authorizations

Query parameters

loyaltyCustomerIdstring · uuid

The ID of the Loyalty Customer. Note: May not be used in combination with the email parameter

emailstring · email

The email address of the Loyalty Customer. Note: May not be used in combination with the loyaltyCustomerId parameter

Example: email@example.com

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

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

An object containing basic details about a Loyalty Customer.

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.

get

/loyalty/earning_rules

Authorizations

Query parameters

loyaltyCustomerIdstring · uuid

The ID of the Loyalty Customer. Note: May not be used in combination with the email parameter

emailstring · email

The email address of the Loyalty Customer. Note: May not be used in combination with the loyaltyCustomerId parameter

Example: email@example.com

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

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

An object containing a list of earning rules.

Trigger a custom earning rule for a Loyalty Customer

post

/loyalty/earning_transactions

Authorizations

Body

actionIdstringrequired

The action ID of the custom earning rule.

Example: k2d6ne

valuenumber

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

Example: 10

customerIdentifierobjectrequired

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/loyalty/earning_transactions' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"actionId":"k2d6ne","value":10,"customerIdentifier":{}}'

200

400

401

403

404

422

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

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

List ways to redeem loyalty points for rewards

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

get

/loyalty/redemption_rules

Authorizations

Query parameters

loyaltyCustomerIdstring · uuid

The ID of the Loyalty Customer. Note: May not be used in combination with the email parameter

emailstring · email

The email address of the Loyalty Customer. Note: May not be used in combination with the loyaltyCustomerId parameter

Example: email@example.com

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

403

404

{
  "rules": [
    {
      "redemptionRuleId": "123e4567-e89b-12d3-a456-426614174000",
      "expiresAfterDays": 1,
      "minimumPurchase": 1,
      "recurringCycleLimit": 1,
      "purchaseType": "single",
      "appliesToCollections": {
        "collectionId": 388918313199,
        "title": "Clothing",
        "url": "https://example.myshopify.com/collections/clothing"
      },
      "type": "fixed-value",
      "reward": {
        "points": 1,
        "value": 1,
        "awardVia": "coupon"
      }
    }
  ]
}

An object containing a list of redemption rules.

Redeem a redemption reward for a Loyalty Customer

post

/loyalty/redemption_transactions

Authorizations

Body

redemptionRuleIdstring · uuidrequired

The unique identifier for the redemption rule.

variableValueobject

customerIdentifierobjectrequired

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/loyalty/redemption_transactions' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"redemptionRuleId":"123e4567-e89b-12d3-a456-426614174000","variableValue":{"points":100,"value":10},"customerIdentifier":{}}'

200

400

403

404

500

{
  "transactionDetails": {
    "amount": 100
  },
  "loyaltyCustomer": {
    "points": {
      "balance": 1000
    }
  },
  "reward": {
    "status": "completed",
    "type": "store-credit",
    "storeCredit": {
      "balanceAmount": "$100",
      "transactionAmount": "$10"
    }
  }
}

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

Adjust the points balance of a Loyalty Customer

post

/loyalty/adjustment_transactions

Authorizations

Body

amountinteger · int32required

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

customerIdentifierobjectrequired

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/loyalty/adjustment_transactions' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"amount":10,"internalReason":"Gifted points due to bad shipping experience","notificationText":"Gifted Points","customerIdentifier":{}}'

200

400

401

403

404

422

{
  "loyaltyCustomer": {
    "points": {
      "balance": 1
    }
  }
}

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

Set a Loyalty Customer's minimum VIP Tier

post

/loyalty/customer_minimum_vip_tiers

Authorizations

Body

minimumVipTierNamestring | nullablerequired

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

Example: Silver

customerIdentifierobjectrequired

An object identifying the Loyalty Customer by email or loyaltyCustomerId.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/loyalty/customer_minimum_vip_tiers' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"minimumVipTierName":"Silver","customerIdentifier":{}}'

200

400

401

403

404

422

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

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

Look up a Customer's ID by email address

post

/customer_lookup

Authorizations

Body

emailstring · emailrequired

The email address of the Customer to look up.

Example: jane@example.com

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/customer_lookup' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"email":"jane@example.com"}'

200

400

401

404

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

A Customer was found matching the provided email address.

Retrieve basic details about a Customer

get

/customers/{customerId}

Authorizations

Path parameters

customerIdstring · uuidrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.okendo.io/enterprise/customers/{customerId}' \
  --header 'Authorization: Basic username:password'

200

401

404

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

An object containing basic details about a Customer.

List Customer Profiles and their included properties

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

get

/customers/{customerId}/profiles

Authorizations

Path parameters

customerIdstring · uuidrequired

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

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.

namespacestring

The identifier used to group Customer data. Specify this property to filter the Customer's profile data to a specific namespace.

Example: okendo-general

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.okendo.io/enterprise/customers/{customerId}/profiles' \
  --header 'Authorization: Basic username:password'

200

400

401

{
  "nextUrl": "https://example.com",
  "profiles": [
    {
      "namespace": "okendo-general",
      "properties": [
        {
          "name": "Given Name",
          "value": "Jane",
          "valueType": "string",
          "date": "2025-02-21T18:18:18.577Z"
        }
      ]
    }
  ]
}

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

List Customer Activities

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

get

/customers/{customerId}/activities

Authorizations

Path parameters

customerIdstring · uuidrequired

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

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.

namespacestring

The identifier used to group Customer data. Specify this property to filter the Customer's activities to a specific namespace.

Example: okendo-general

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.okendo.io/enterprise/customers/{customerId}/activities' \
  --header 'Authorization: Basic username:password'

200

400

401

{
  "nextUrl": "https://example.com",
  "activities": [
    {
      "activityId": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "okendo-general",
      "date": "2025-02-21T18:18:18.577Z",
      "title": "Review Submitted"
    }
  ]
}

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

Create a Shopify backed group and return the group created

post

/groups

Authorizations

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.okendo.io/enterprise/groups' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","isAutoAssignProductsEnabled":true,"shopifyCollectionId":123456789}'

200

400

401

409

422

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

An object containing the group that was just created.

Reviews

Loyalty

Customers

Groups

Reviews

Loyalty

Customers

Groups

List Reviews

Reply to a Review

Retrieve basic details about a Loyalty Customer

List ways to earn loyalty points

Trigger a custom earning rule for a Loyalty Customer

List ways to redeem loyalty points for rewards

Redeem a redemption reward for a Loyalty Customer

Adjust the points balance of a Loyalty Customer

Set a Loyalty Customer's minimum VIP Tier

Look up a Customer's ID by email address

Retrieve basic details about a Customer

List Customer Profiles and their included properties

List Customer Activities

Create a Shopify backed group and return the group created