Overview In version 4.7, we released a new trigger to customize Javascript and CSS by page-type, This allows better organization of custom JS/CSS. Previously, Javascript could only be added Globally under Customer Sites -> Advanced section. We’ll identify what changes have been made with this new functionality in this article….
Overview This article provides an overview of the changes in release 2022.R1.5 (CIMcloud internal tag 4.5) Release date: 6/22/2023 Updates and Fixes Product Configurator Introduced Product Configurator into core product. For a full list of features and setup information, please review our Product Configurator category for a list of articles…
Overview With Product Configurator, you can map products to add to the cart based off the question displayed, or an answer that is selected. Flexible Product Rules Assign products to questions or answers Qty and weight can be set on product mappings Pricing can use Sage’s standard pricing or can…
Creating/Modifying Answers In order to set up an answer, you need to include general information similar to setting up a question. Such as internal identifiers, and external/human-friendly descriptions so that your customers have a better idea of what they are selecting General Information Reference ID (ref_id) This is a unique…
Creating/Modifying Questions There are four places you can setup/manage questions: On the Product Add-Edit page Manage questions under the “Configuration Questions” section On the Product Configurations interface page Head to Product Catalog > Product Configurations Select your configuration Note: “Enable Product Questions” must be turned on the Product Add-Edit page…
Setup Once Product Configurator is purchased and turned on, you will need to enable the following features: Under Workspace Settings Enable Product Configurator System for Workers Screenshot [A] below Under Application Settings > Product Catalog Enable Product Configurator Screenshot [B] below With both the above enabled, you should now see:…
Overview Product Configurator is a powerful, scalable module for allowing customers to make complex purchases using a simple user interface. This is one of the more complex features to implement due to the data requirements that come with any configurator, but once implemented is a great way to present your…
Overview As of release 2022.R1.4 (v4.4.0), Google Analytics 4 is now supported in core product. Please see our Google Analytics 4 (GA4) – What To Know article for more information on this update. This article will cover how you can install Google Analytics 4 on your site, and any notables…
Overview In Release 2022.R1.3 (4.3), we added the ability to block access to the sitefront by an IP Address. You can manage which IP addresses are blocked under System Wide Settings -> Block IP Addresses [Reference A]. On the manage page, or in the navigation siderail, you are able to…
Once your CIMcloud Authorization is created with Resources assigned, an automated process will generate documentation for the endpoints available. This is generated once per day for each Authorization; however, we can generate this more frequently if requested. Please submit a ticket to Extranet for us to increase the frequency. You…
The default records returned on a GET request is 50 results. You can use pagination to cycle through results with the following format: Endpoint: https://api.cimcloud.com/{sitename}/{resource}/{searchstring}/{page_number} Notes: {page_number} starts at 1, where an empty or 0 value is treated the first 50 records {searchstring} is optional (see the searchstring article for…
This section covers a few technical basics related to the CIMcloud API. Authentication is needed on all requests, excluding canary endpoints, to the API via Bearer Tokens Note: The canary endpoint does not require authentication, which allows users to ping for availability Update 1-29-2024 We now offer basic authentication on…
To help orient you with the API Framework, the following definitions will be used throughout: App Authorizations: Contains credentials to authorize an API connection, connection settings, and accessible API Resources For example, you could create an authorization to only allow GETs, and another authorization that allows GETs and POSTs, for…
Before you can begin calling the CIMcloud API, you’ll need to create a App Authorization. This is located in your Worker Portal under API System -> App Authorization. You can either click the blue + in the navigation links, head to the manage page to create your first App Authorization,…
Full List of Core Resources / Endpoints Base Resources https://api.cimcloud.com/{sitename}/Accounts https://api.cimcloud.com/{sitename}/Customers https://api.cimcloud.com/{sitename}/CustomerTaxCodes https://api.cimcloud.com/{sitename}/DirectoryListings https://api.cimcloud.com/{sitename}/InvoiceDetails https://api.cimcloud.com/{sitename}/InvoiceHeaders https://api.cimcloud.com/{sitename}/InvoicePayments https://api.cimcloud.com/{sitename}/SalesOrderDetails https://api.cimcloud.com/{sitename}/SalesOrderHeaders https://api.cimcloud.com/{sitename}/Shipments https://api.cimcloud.com/{sitename}/OnlineOrders https://api.cimcloud.com/{sitename}/OnlinePayments https://api.cimcloud.com/{sitename}/PriceGroups https://api.cimcloud.com/{sitename}/PriceOverrides https://api.cimcloud.com/{sitename}/ProductAliases https://api.cimcloud.com/{sitename}/Products https://api.cimcloud.com/{sitename}/ShippingAddresses https://api.cimcloud.com/{sitename}/TaxClasses https://api.cimcloud.com/{sitename}/TaxCodes https://api.cimcloud.com/{sitename}/TaxRates https://api.cimcloud.com/{sitename}/TaxScheduleZipCodeMap https://api.cimcloud.com/{sitename}/TaxSchedules https://api.cimcloud.com/{sitename}/TaxScheduleTaxCodeMap Inventory Bundle Resources https://api.cimcloud.com/{sitename}/InventoryLevels https://api.cimcloud.com/{sitename}/ProductWarehouses Order Pass-Through Resources https://api.cimcloud.com/{sitename}/OrderPassThroughDetails https://api.cimcloud.com/{sitename}/OrderPassThroughHeaders
POST Requests Overview POST requests allow you to add or edit data in the CIMcloud platform via the API If a data record sent via a POST already exists, it will update it. If a data record sent via a POST does not exists, it will add a new record….
Overview GET requests allow you to retrieve data from the CIMcloud API / platform. Results can be filtered by Searchstrings or Pagination. Example: Get All Accounts Description: Endpoint to retrieve all accounts. Endpoint: https://api.cimcloud.com/{sitename}/accounts/ Example: Get All Customers Description: Endpoint to retrieve all customers. Endpoint: https://api.cimcloud.com/{sitename}/customers/ Example: Get All Products…
API Health Checks The CIMcloud API supports the following two health checks. These are both GET requests. Canary Description: No authentication token needed, allows you to check the status of the API layer to determine if the API layer is down or running. Endpoint: https://api.cimcloud.com/{sitename}/healthcheck/canary Healthcheck Description: Requires the Authentication…
Finding Your Authentication Credentials Head to the backend of your website to obtain credentials: Login to the Worker Portal Search for App Authorizations and click on the menu link Click “Edit” under the actions column for the Authorization Credentials are located in the “Authorization Information” section (Reference below) When resetting…
Overview CIMcloud releases new core versions each week in the form of patch, minor, and major versions. As a SaSS-centric company, we encourage all our customer’s to be on the latest version for a variety of reasons. At this time, CIMcloud involvement is required as we work towards customers updating…
Subscribe to receive email updates of what's new in the CIMcloud Help Center.