Using the API

Overview This article provides an overview of the CIMcloud API.  It covers the following topics: “API” Defined (a Few Concepts)...

This article provides an overview of the CIMcloud API Framework with examples.  This article is intended to be a technical...

To help orient you with the API Framework, the following definitions will be used throughout: App Authorizations: Contains credentials to...

This section covers a few technical basics related to the CIMcloud API. Authentication is needed on all requests, excluding canary...

Before you can begin calling the CIMcloud API, you’ll need to create a App Authorization.  This is located in your...

Once your CIMcloud Authorization is created with Resources assigned, an automated process will generate documentation for the endpoints available.  This...

Finding Your Authentication Credentials Head to the backend of your website to obtain credentials: Login to the Worker Portal Search...

API Health Checks The CIMcloud API supports the following two health checks.  These are both GET requests. Canary Description: No...

Overview GET requests allow you to retrieve data from the CIMcloud API / platform. Results can be filtered by Searchstrings...

Overview This article provides technical details on how to filter the data records returned when making a GET call to...

The default records returned on a GET request is 50 results.  You can use pagination to cycle through results with...

POST Requests Overview POST requests allow you to add or edit data in the CIMcloud platform via the API If...

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

Overview The OrderPassthrough endpoint allows you to create an order along with it’s details in the CIMcloud platform via the...

Overview This endpoint allows you to generate a Session, which can then be used to return Customer-specific pricing in a...

HTTP status codes the server can generate in response to HTTP requests via the API Framework: 200 OK: Your request...