OpSuite connector icon

OpSuite Integrations

Build & publish in-app integrations with our OpSuite connector

Build with this Connector Talk to an integration expert
01

Low-code orchestration

Connect, compose and ship AI features faster.

02

Multi-tenant deployment

Isolate customer credentials and configurations at scale.

03

Governed access

Apply policies, field controls and audit trails across usage.

04

Embedded experience

Deliver workflows natively inside your product.

CONNECTOR OVERVIEW

Create automations with our OpSuite connector

Cyclr enables SaaS platforms to integrate their application with hundreds of other platforms. Use Cyclr’s low code integration builder to integrate your application with OpSuite, so you can provide in-app OpSuite integrations for your end users.

PRODUCT USE CASES

Top Use Cases for OpSuite Integrations

Quickly create integrations between your SaaS application and OpSuite with Cyclr's low code integration builder. Publish your OpSuite integration into your application using Cyclr's white label embedded integration marketplace.

Marketing

  • Create new customers from landing page leads and follow up with 'welcome' email campaign
  • Add new sales leads to email marketing lists

POS

  • Sync new POS transactions with sales contacts
  • Add note to sales lead from POS transaction data

Ecommerce

  • Add sales leads from new ecommerce orders

ORCHESTRATION

How OpSuite works with Cyclr

Cyclr sits between your SaaS product and OpSuite to handle authentication, govern access and orchestrate every API call per customer, at scale.

  1. 1

    Your SaaS product

    Your app requests an action for a specific customer.

  2. 2

    Cyclr orchestration

    Cyclr authenticates, applies policies and routes the request.

  3. 3

    OpSuite

    OpSuite processes the request and returns a response to your app.

Customer-specific authentication · Governed data movement · Centralized visibility and audit

CONNECTOR COVERAGE

Available connector capabilities

Explore OpSuite methods you can orchestrate through Cyclr.

Account Types1

List Account Types

Action

Retrieves an array of AccountTypes, subject to the search parameters.

Communities2

CommunitiesByCommunityIdMembersGet

Action

Returns a list of current memberships for the specified community.

CommunitiesGet

Action

Returns an array of Communities, subject to the search parameters.

Categories6

Update Categories

Action

Updates specified properties of multiple categories.

Add Category

Action

Creates a new category.

Update Category

Action

Updates specified properties of a category.

Get Category by Id

Action

Returns a single Category with the specified id.

Get Category by Code

Action

Returns a single Category with the specified code.

Add Categories

Action

Creates multiple new categories.

Countries1

List Countries

Action

Returns an array of Iso Countries.

Vouchers7

VouchersByVoucherIdPatch

Action

Updates specified properties of a voucher.

VouchersGet

Action

Returns an array of Vouchers that match the specified search criteria.

VouchersPost

Action

Creates a new voucher.

VouchersGetVoucherByNumberGet

Action

Returns a single Voucher with the specified number.

VouchersPatchMultipleVouchersPatch

Action

Updates specified properties of multiple vouchers.

VouchersByVoucherIdGet

Action

Returns a single Voucher with the specified id.

VouchersPostMultipleVouchersPost

Action

Creates multiple new vouchers.

Promotion Headers2

PromotionHeadersByPromotionIdGet

Action

Returns a single PromotionHeader with the specified id.

PromotionHeadersGet

Action

Returns an array of Promotion Headers that match the specified search criteria.

Reason Codes2

Get Reason Code

Action

Returns a single ReasonCode with the specified id.

List Reason Codes

Action

Returns an array of Reason Codes that match the specified search criteria.

Sales Orders3

SalesOrdersByOrderIdGet

Action

Returns the specified sales order transaction.

SalesOrdersByOrderIdClosedStatusGet

Action

Returns the closed status for the specified sales order.

SalesOrdersGet

Action

Returns an array of SalesOrders that match the specified search criteria.

Sales Reps1

List Sales Reps

Action

Returns an array of SalesReps that match the specified search criteria.

Mailers1

MailerLogBulkUpdatesPost

Action

Updates the mailer status of a collection of customers.

Cashiers2

List Cashiers

Action

Returns a list of Cashiers, subject to the search parameters.

Get Cashier

Action

Returns a single Cashier with the specified id.

Person Titles1

List Person Titles

Action

Returns an array of Person Titles.

Units of Measure6

UnitsOfMeasureByUnitOfMeasureIdPatch

Action

Updates specified properties of a UnitOfMeasure.

UnitsOfMeasureDefaultUomIdGet

Action

Returns an integer which is the id of the default unit of measure.

UnitsOfMeasurePost

Action

Creates a new UnitOfMeasure.

List Units of Measure

Action

Returns an array of UnitOfMeasure with the specified description.

UnitsOfMeasureGetUnitOfMeasureByCodeGet

Action

Returns a single UnitOfMeasure with the specified code.

UnitsOfMeasureByUnitOfMeasureIdGet

Action

Returns a single UnitOfMeasure with the specified id.

Departments6

DepartmentsGetDepartmentByCodeGet

Action

Returns a single Department with the specified code.

Update Department

Action

Updates specified properties of a department.

DepartmentsPatchMultipleDepartmentsPatch

Action

Updates specified properties of multiple departments.

DepartmentsByDepartmentIdGet

Action

Returns a single Department with the specified id.

DepartmentsPost

Action

Creates a new department.

Create Departments

Action

Creates multiple new departments.

Transactions6

TransactionsPost

Action

Creates a new transaction.

TransactionsGetTransactionsWithIdGreaterThanSpecifiedIdGet

Action

Returns an array of Transactions with an id greater than the specified id.

TransactionHeadersGet

Action

Returns an array of TransactionHeaders that match the specified search criteria.

TransactionStatusesGet

Action

Retrieves an array of TransactionStatuses, subject to the search parameters.

TransactionsByTransactionIdGet

Action

Returns a single Transaction with the specified id.

TransactionHeadersByTransactionIdLinesGet

Action

Returns an array of transaction lines for the specified transaction header.

Simple Tax Rates5

SimpleTaxRatesGetSimpleTaxRateByCodeGet

Action

Returns a single SimpleTaxRate with the specified code.

SimpleTaxRatesByIdGet

Action

Returns a single SimpleTaxRate with the specified id.

SimpleTaxRatesGet

Action

Returns an array of SimpleTaxRates.

SimpleTaxRatesByIdPatch

Action

Updates specified properties of a simple tax rate.

SimpleTaxRatesPost

Action

Creates a new simple tax rate.

Internal1

Get Token

Action

Customers26

CustomerLoyaltyFieldsGet

Action

Returns an array of customer loyalty fields.

CustomerContactsByIdPatch

Action

Updates specified properties of a customer contact.

CustomerContactsPost

Action

Creates a new customer contact.

CustomerContactsByIdGet

Action

Returns the customer contact with the specified id.

CustomerContactsPut

Action

Updates a customer contact.

CustomerContactsByIdDelete

Action

Deletes the specified customer contact.

CustomerLoyaltyFieldsPut

Action

Updates a batch of customer loyalty field.

CustomersByCustomerIdLoyaltyBalancesGet

Action

Returns an array of loyalty point balances for the specified customer.

CustomersByCustomerIdAlternativeShipToContactsGet

Action

Returns an array of alternative ship to contacts for the specified customer.

CustomerLoyaltyFieldTypesGet

Action

Returns an array of Customer Loyalty Field Types.

CustomerLoyaltyFieldConfigsGet

Action

Returns an array of Customer Loyalty Field Configurations.

CustomersByCustomerIdContactsGet

Action

Returns an array of other contacts for the specified customer.

CustomerLoyaltyFieldsBulkUpdatesPost

Action

Creates a new set of loyalty points.

CustomersByCustomerIdLoyaltyCardsGet

Action

Returns an array of loyalty cards for the specified customer.

CustomersByCustomerIdTransactionHeadersGet

Action

Returns an array of transaction headers for the specified customer.

CustomersByCustomerIdLoyaltyTransactionsGet

Action

Returns an array of loyalty transactions for the specified customer.

CustomersPost

Action

Creates a new customer.

CustomersGetCustomerByAccountNumberGet

Action

Returns a single Customer with the specified account number or loyalty card number.

CustomersGet

Action

Returns an array of Customers that match the specified search criteria.

CustomersPut

Action

Updates a batch of customers.

CustomersByCustomerIdPatch

Action

Updates specified properties of a customer.

CustomersByCustomerIdPromotionCouponsGet

Action

Returns an array of promotion coupons for the specified customer.

CustomersByCustomerIdDiscountCouponsGet

Action

Returns an array of discount coupons for the specified customer.

CustomersExpiryingLoyaltyTransactionsGet

Action

Returns an array of expiring loyalty transactions for the specified customers.

CustomersByCustomerIdCustomerLoyaltyFieldsGet

Action

Returns the customer loyalty fields for the specified customer.

CustomersByCustomerIdGet

Action

Returns a single Customer with the specified id.

Items30

Get Item Location Questions

Action

Returns an array of Questions associated with the specified ItemLocationDetail.

Get Location

Action

Returns a single Location with the specified code.

ItemLocationDetailsGetItemLocationDetailByLocationIdAndItemMasterIdGet

Action

Returns a single ItemLocationDetail with the specified LocationId and ItemMasterId

ItemLocationDetailsPatchMultipleItemLocationDetailsPatch

Action

Updates specified properties of multiple ItemLocationDetails.

List Items by Master Ids

Action

Returns a list of ItemDetails for the specified list of item master ids.

Get Item By Master Id

Action

Returns a single ItemDetails with the specified item master id

Get Item Inventory Details By SKU

Action

Returns a single ItemDetails with the specified SKU.

List Item Details By Sku

Action

Returns a list of ItemDetails for the specified list of skus.

Get Item Details By Sku

Action

Returns a single ItemDetails with the specified sku.

ItemsByItemLocationDetailIdItemQuestionsGet

Action

Returns an array of Questions associated with the item with the specified itemLocationDetailId

ItemsGetItemByLocationIdAndProductCodeGet

Action

Returns a single Item with the specified location id and product code.Product code can be the item sku, barcode number, or any of an items's alias skus.

Get Master by Sku

Action

Returns a single ItemMaster with the specified sku.

Add Master

Action

Creates a new item master.

List Item Masters

Action

Returns an array of ItemMasters that match the specified search criteria.

Add Items Location Details

Action

Creates multiple new item location details.

Add Masters

Action

Creates multiple new item masters.

Update Aliases

Action

Updates specified properties of multiple item aliases.

Delete Alias

Action

Deletes a single item alias by reference to id.

Get Alias by Alias

Action

Returns a single ItemAlias with the specified alias.

Add Aliases

Action

Creates multiple new ItemAliases.

Get Alias by Id

Action

Returns a single ItemAlias with the specified id.

List Updated Item Locations

Action

Returns an array of ItemLocationDetails that have been modified since the specified date

Update Masters

Action

Updates specified properties of multiple item masters.

ItemMasterAttributesByItemMasterIdGet

Action

Returns a list of attributes for the ItemMaster with the specified id.

List Locations

Action

Returns an array of Locations.

ItemMasterAttributesGetItemMasterAttributesBySkuGet

Action

Returns a list of attributes for the ItemMaster with the specified sku.

Get Item

Action

Returns a single ItemMaster with the specified id.

List Attribute Groups

Action

Returns the list of item master attribute groups.

ItemMasterAttributesGetItemMastersWithAttributesByIdsGet

Action

Returns a list item masters with attributes for the ItemMaster with the specified ids.

ItemMasterAttributesGetItemMastersWithAttributesBySkusGet

Action

Returns a list item masters with attributes for the ItemMaster with the specified skus.

Loyalty4

LoyaltyPointsBulkUpdatesPost

Action

Creates a new set of loyalty points.

LoyaltyTypesGet

Action

Returns an array of Loyalty Types that match the specified search criteria.

LoyaltyCardsByLoyaltyCardIdGet

Action

Returns a single LoyaltyCard with the specified id.

LoyaltyCardsGetLoyaltyCardByNumberGet

Action

Returns a single LoyaltyCard with the specified number.

Suppliers7

SupplierItemsPatchMultipleSupplierItemsPatch

Action

Updates specified properties of multiple SupplierItems.

Search Suppliers

Action

Returns an array of Suppliers that match the specified search criteria.

SuppliersGetSupplierByCodeGet

Action

Returns a single Supplier with the specified code.

SupplierItemsGetSupplierItemBySupplierIdAndItemMasterIdGet

Action

Returns a single SupplierItem with the specified supplierId and itemMasterId.

SupplierItemsPostMultipleSupplierItemsPost

Action

Creates multiple new SupplierItems.

SupplierItemsGetSupplierItemBySupplierIdAndItemMasterIdGet, Copy of

Action

Returns a single SupplierItem with the specified supplierId and itemMasterId.

SupplierItemsBySupplierItemIdDelete

Action

Deletes a single SupplierItem by reference to id.

TECHNICAL DETAILS

OpSuite integration and API details

Review the sourced authentication and API behaviour used when configuring customer-facing OpSuite integrations in Cyclr.

API and authentication

API host
Not specified
Authentication
See Connector in Console
Credentials

Review the connector installation fields in Cyclr Console.

Method categories

See available methods

Pagination and rate limits

Pagination

Method-specific behavior should be confirmed before implementation.

Rate limits

Refer to the vendor API documentation for current limits.

IMPLEMENTATION

Authentication at a glance

Authentication requirements and any available connection options are shown when installing this connector in Cyclr Console.

Authentication method
See Connector in Console
Credential required

Review the connector installation fields in Cyclr Console.

KEEP EXPLORING

Related resources and connectors

Documentation

OpSuite Connector Documentation

Read more →Resource

Teaming up your POS and eCommerce Integrations

Read more →Resource

Break down the Sales Process with Useful Sales Integrations

Read more →

Let Cyclr handle the integrations.

You focus on building the product your customers love.

Start building for free Get a demo