Cin7 Core

Cin7 Core

This connector works with Cin7 Core, the inventory management system formerly called DEAR Inventory (signs in at inventory.dearsystems.com), through its External API v2 at https://inventory.dearsystems.com/ExternalApi/v2: products and stock availability, sales with their orders, fulfilments, invoices and payments (read only), purchases, customers, suppliers, stock adjustments and stock transfers.

Core or Omni? Cin7 sells two different products. Cin7 Core (this connector, ex DEAR Systems) uses an Account ID and an Application Key. Cin7 Omni (the original Cin7, go.cin7.com) has a separate API v1 with an API username and key: use the cin7-omni connector for it. The credentials of one do not work on the other.

Setup (about 2 minutes)

1. In Cin7 Core open the API setup page, Integrations, API (https://inventory.dearsystems.com/ExternalAPI).
2. Click + to add an API application and give it a name.
3. Copy the Account ID into CIN7_CORE_ACCOUNT_ID and the Application Key into CIN7_CORE_APPLICATION_KEY.

The connector sends them in the api-auth-accountid and api-auth-applicationkey headers. Deleting the API application revokes the key.

Where to start: cin7_core_get_me checks the connection and shows the base currency; cin7_core_list_locations gives location names; cin7_core_list_sales and cin7_core_get_product_availability answer most questions.

Reading: cin7_core_list_products, cin7_core_get_product_availability, cin7_core_list_sales, cin7_core_get_sale, cin7_core_get_sale_order, cin7_core_get_sale_fulfilments, cin7_core_get_sale_invoices, cin7_core_get_sale_payments, cin7_core_list_purchases, cin7_core_get_purchase, cin7_core_get_purchase_order, cin7_core_list_customers, cin7_core_list_suppliers, cin7_core_list_tax_rules, cin7_core_list_payment_terms, cin7_core_list_stock_adjustments, cin7_core_get_stock_adjustment, cin7_core_list_stock_transfers, cin7_core_get_stock_transfer.

Creating a sale takes two calls: cin7_core_create_sale makes the header (customer, location) and returns its ID; cin7_core_create_sale_order adds the lines. Lines need Name, Quantity, Price, Tax and TaxRule plus SKU or ProductID. Keep the order DRAFT unless the user wants it authorised: AUTHORISED allocates stock, backorders shortfalls silently and locks the order against further API edits. Purchases work the same way: cin7_core_create_purchase, then cin7_core_create_purchase_order.

Other writes: cin7_core_create_customer, cin7_core_update_customer, cin7_core_create_supplier (they need payment term and tax rule names and account codes), cin7_core_create_stock_transfer (DRAFT by default). cin7_core_create_stock_adjustment is installed switched off: a COMPLETED adjustment posts stock movements and accounting entries at once, and its quantities are the new on-hand values, not differences. The connector never records, changes or deletes payments, invoices or credit notes, and has no delete or void tools.

Identifiers: records use GUIDs (ID, SaleID, TaskID). Locations, tax rules, payment terms and price tiers are referenced by name.

Paging: lists take page (from 1) and limit (default 100, at most 1000); the answer has Total and the records under a list key (Products, SaleList, PurchaseList, CustomerList...). Use updated_since or modified_since for incremental reads. Dates are UTC, yyyy-MM-ddTHH:mm:ss.

Rate limit: 60 calls per minute per API application; beyond that Cin7 Core answers 429 (older accounts 503). Use large pages and filters instead of many small calls.

Errors: a refused call answers 400 with [{"ErrorCode": 400, "Exception": "..."}] naming the problem (unknown customer, location or tax rule, a document that is already authorised). 403 means a wrong Account ID or Application Key.