Integrate OpSuite

Provide your users with in-app integration with OpSuite

OpSuite connector

OpSuite

OpSuite Next Generation Retail Solutions provide business owners and managers with the tools and technology needed to drive business forward.

OpSuite Connector Methods

Account Types

Feature Description Type
List Account Types Retrieves an array of AccountTypes, subject to the search parameters. Action

Communities

Feature Description Type
CommunitiesByCommunityIdMembersGet Returns a list of current memberships for the specified community. Action
CommunitiesGet Returns an array of Communities, subject to the search parameters. Action

Categories

Feature Description Type
Update Categories Updates specified properties of multiple categories. Action
Add Category Creates a new category. Action
Update Category Updates specified properties of a category. Action
Get Category by Id Returns a single Category with the specified id. Action
Get Category by Code Returns a single Category with the specified code. Action
Add Categories Creates multiple new categories. Action

Countries

Feature Description Type
List Countries Returns an array of Iso Countries. Action

Vouchers

Feature Description Type
VouchersByVoucherIdPatch Updates specified properties of a voucher. Action
VouchersGet Returns an array of Vouchers that match the specified search criteria. Action
VouchersPost Creates a new voucher. Action
VouchersGetVoucherByNumberGet Returns a single Voucher with the specified number. Action
VouchersPatchMultipleVouchersPatch Updates specified properties of multiple vouchers. Action
VouchersByVoucherIdGet Returns a single Voucher with the specified id. Action
VouchersPostMultipleVouchersPost Creates multiple new vouchers. Action

Promotion Headers

Feature Description Type
PromotionHeadersByPromotionIdGet Returns a single PromotionHeader with the specified id. Action
PromotionHeadersGet Returns an array of Promotion Headers that match the specified search criteria. Action

Reason Codes

Feature Description Type
Get Reason Code Returns a single ReasonCode with the specified id. Action
List Reason Codes Returns an array of Reason Codes that match the specified search criteria. Action

Sales Orders

Feature Description Type
SalesOrdersByOrderIdGet Returns the specified sales order transaction. Action
SalesOrdersByOrderIdClosedStatusGet Returns the closed status for the specified sales order. Action
SalesOrdersGet Returns an array of SalesOrders that match the specified search criteria. Action

Sales Reps

Feature Description Type
List Sales Reps Returns an array of SalesReps that match the specified search criteria. Action

Mailers

Feature Description Type
MailerLogBulkUpdatesPost Updates the mailer status of a collection of customers. Action

Cashiers

Feature Description Type
List Cashiers Returns a list of Cashiers, subject to the search parameters. Action
Get Cashier Returns a single Cashier with the specified id. Action

Person Titles

Feature Description Type
List Person Titles Returns an array of Person Titles. Action

Units of Measure

Feature Description Type
UnitsOfMeasureByUnitOfMeasureIdPatch Updates specified properties of a UnitOfMeasure. Action
UnitsOfMeasureDefaultUomIdGet Returns an integer which is the id of the default unit of measure. Action
UnitsOfMeasurePost Creates a new UnitOfMeasure. Action
List Units of Measure Returns an array of UnitOfMeasure with the specified description. Action
UnitsOfMeasureGetUnitOfMeasureByCodeGet Returns a single UnitOfMeasure with the specified code. Action
UnitsOfMeasureByUnitOfMeasureIdGet Returns a single UnitOfMeasure with the specified id. Action

Departments

Feature Description Type
DepartmentsGetDepartmentByCodeGet Returns a single Department with the specified code. Action
Update Department Updates specified properties of a department. Action
DepartmentsPatchMultipleDepartmentsPatch Updates specified properties of multiple departments. Action
DepartmentsByDepartmentIdGet Returns a single Department with the specified id. Action
DepartmentsPost Creates a new department. Action
Create Departments Creates multiple new departments. Action

Transactions

Feature Description Type
TransactionsPost Creates a new transaction. Action
TransactionsGetTransactionsWithIdGreaterThanSpecifiedIdGet Returns an array of Transactions with an id greater than the specified id. Action
TransactionHeadersGet Returns an array of TransactionHeaders that match the specified search criteria. Action
TransactionStatusesGet Retrieves an array of TransactionStatuses, subject to the search parameters. Action
TransactionsByTransactionIdGet Returns a single Transaction with the specified id. Action
TransactionHeadersByTransactionIdLinesGet Returns an array of transaction lines for the specified transaction header. Action

Simple Tax Rates

Feature Description Type
SimpleTaxRatesGetSimpleTaxRateByCodeGet Returns a single SimpleTaxRate with the specified code. Action
SimpleTaxRatesByIdGet Returns a single SimpleTaxRate with the specified id. Action
SimpleTaxRatesGet Returns an array of SimpleTaxRates. Action
SimpleTaxRatesByIdPatch Updates specified properties of a simple tax rate. Action
SimpleTaxRatesPost Creates a new simple tax rate. Action

Internal

Feature Description Type
Get Token Action

Customers

Feature Description Type
CustomerLoyaltyFieldsGet Returns an array of customer loyalty fields. Action
CustomerContactsByIdPatch Updates specified properties of a customer contact. Action
CustomerContactsPost Creates a new customer contact. Action
CustomerContactsByIdGet Returns the customer contact with the specified id. Action
CustomerContactsPut Updates a customer contact. Action
CustomerContactsByIdDelete Deletes the specified customer contact. Action
CustomerLoyaltyFieldsPut Updates a batch of customer loyalty field. Action
CustomersByCustomerIdLoyaltyBalancesGet Returns an array of loyalty point balances for the specified customer. Action
CustomersByCustomerIdAlternativeShipToContactsGet Returns an array of alternative ship to contacts for the specified customer. Action
CustomerLoyaltyFieldTypesGet Returns an array of Customer Loyalty Field Types. Action
CustomerLoyaltyFieldConfigsGet Returns an array of Customer Loyalty Field Configurations. Action
CustomersByCustomerIdContactsGet Returns an array of other contacts for the specified customer. Action
CustomerLoyaltyFieldsBulkUpdatesPost Creates a new set of loyalty points. Action
CustomersByCustomerIdLoyaltyCardsGet Returns an array of loyalty cards for the specified customer. Action
CustomersByCustomerIdTransactionHeadersGet Returns an array of transaction headers for the specified customer. Action
CustomersByCustomerIdLoyaltyTransactionsGet Returns an array of loyalty transactions for the specified customer. Action
CustomersPost Creates a new customer. Action
CustomersGetCustomerByAccountNumberGet Returns a single Customer with the specified account number or loyalty card number. Action
CustomersGet Returns an array of Customers that match the specified search criteria. Action
CustomersPut Updates a batch of customers. Action
CustomersByCustomerIdPatch Updates specified properties of a customer. Action
CustomersByCustomerIdPromotionCouponsGet Returns an array of promotion coupons for the specified customer. Action
CustomersByCustomerIdDiscountCouponsGet Returns an array of discount coupons for the specified customer. Action
CustomersExpiryingLoyaltyTransactionsGet Returns an array of expiring loyalty transactions for the specified customers. Action
CustomersByCustomerIdCustomerLoyaltyFieldsGet Returns the customer loyalty fields for the specified customer. Action
CustomersByCustomerIdGet Returns a single Customer with the specified id. Action

Items

Feature Description Type
Get Item Location Questions Returns an array of Questions associated with the specified ItemLocationDetail. Action
Get Location Returns a single Location with the specified code. Action
ItemLocationDetailsGetItemLocationDetailByLocationIdAndItemMasterIdGet Returns a single ItemLocationDetail with the specified LocationId and ItemMasterId Action
ItemLocationDetailsPatchMultipleItemLocationDetailsPatch Updates specified properties of multiple ItemLocationDetails. Action
List Items by Master Ids Returns a list of ItemDetails for the specified list of item master ids. Action
Get Item By Master Id Returns a single ItemDetails with the specified item master id Action
Get Item Inventory Details By SKU Returns a single ItemDetails with the specified SKU. Action
List Item Details By Sku Returns a list of ItemDetails for the specified list of skus. Action
Get Item Details By Sku Returns a single ItemDetails with the specified sku. Action
ItemsByItemLocationDetailIdItemQuestionsGet Returns an array of Questions associated with the item with the specified itemLocationDetailId Action
ItemsGetItemByLocationIdAndProductCodeGet 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. Action
Get Master by Sku Returns a single ItemMaster with the specified sku. Action
Add Master Creates a new item master. Action
List Item Masters Returns an array of ItemMasters that match the specified search criteria. Action
Add Items Location Details Creates multiple new item location details. Action
Add Masters Creates multiple new item masters. Action
Update Aliases Updates specified properties of multiple item aliases. Action
Delete Alias Deletes a single item alias by reference to id. Action
Get Alias by Alias Returns a single ItemAlias with the specified alias. Action
Add Aliases Creates multiple new ItemAliases. Action
Get Alias by Id Returns a single ItemAlias with the specified id. Action
List Updated Item Locations Returns an array of ItemLocationDetails that have been modified since the specified date Action
Update Masters Updates specified properties of multiple item masters. Action
ItemMasterAttributesByItemMasterIdGet Returns a list of attributes for the ItemMaster with the specified id. Action
List Locations Returns an array of Locations. Action
ItemMasterAttributesGetItemMasterAttributesBySkuGet Returns a list of attributes for the ItemMaster with the specified sku. Action
Get Item Returns a single ItemMaster with the specified id. Action
List Attribute Groups Returns the list of item master attribute groups. Action
ItemMasterAttributesGetItemMastersWithAttributesByIdsGet Returns a list item masters with attributes for the ItemMaster with the specified ids. Action
ItemMasterAttributesGetItemMastersWithAttributesBySkusGet Returns a list item masters with attributes for the ItemMaster with the specified skus. Action

Loyalty

Feature Description Type
LoyaltyPointsBulkUpdatesPost Creates a new set of loyalty points. Action
LoyaltyTypesGet Returns an array of Loyalty Types that match the specified search criteria. Action
LoyaltyCardsByLoyaltyCardIdGet Returns a single LoyaltyCard with the specified id. Action
LoyaltyCardsGetLoyaltyCardByNumberGet Returns a single LoyaltyCard with the specified number. Action

Suppliers

Feature Description Type
SupplierItemsPatchMultipleSupplierItemsPatch Updates specified properties of multiple SupplierItems. Action
Search Suppliers Returns an array of Suppliers that match the specified search criteria. Action
SuppliersGetSupplierByCodeGet Returns a single Supplier with the specified code. Action
SupplierItemsGetSupplierItemBySupplierIdAndItemMasterIdGet Returns a single SupplierItem with the specified supplierId and itemMasterId. Action
SupplierItemsPostMultipleSupplierItemsPost Creates multiple new SupplierItems. Action
SupplierItemsGetSupplierItemBySupplierIdAndItemMasterIdGet, Copy of Returns a single SupplierItem with the specified supplierId and itemMasterId. Action
SupplierItemsBySupplierItemIdDelete Deletes a single SupplierItem by reference to id. Action
Looking for extra functionality in this connector? We build our connectors to our customer requirements, so if you need an extension get in touch.

With Cyclr you also get

300+ APIs

300+ APIs

Our Connector Layer enables you to unlock integrations with our vast library of SaaS Connectors -- instantly.

Always up-to-date

Always up-to-date

Our API connectors are tested automatically every day, we are constantly updating & adding new ones.

No code

No code

Use our drag and drop builder to create embeddable template integrations for your users with our Orchestration Layer.

Native integration

Native integration

Your users access all integrations right inside your app, no more plugins or third-party apps, with our Presentation Layer.