Cin7 Omni

Cin7 Omni

This connector works with Cin7 Omni, the original Cin7 inventory and order management system (signs in at go.cin7.com), through its REST API v1 at https://api.cin7.com/api/v1: sales orders, quotes, purchase orders, credit notes, contacts, products and options, stock per branch, branches, payments (read only), stock adjustments, branch transfers and users.

Omni or Core? Cin7 sells two different products. Cin7 Omni (this connector) signs in at go.cin7.com and has API v1 with an API username and key. Cin7 Core (formerly DEAR Inventory) signs in at inventory.dearsystems.com and has its own API with an Account ID and Application Key: use the cin7-core connector for it. The two APIs and their credentials are not interchangeable.

Setup (about 3 minutes, administrator)

1. In Cin7 Omni open the user menu, Settings, Integrations & API, API v1.
2. Copy the API Username shown there into CIN7_OMNI_API_USERNAME.
3. Click Add New API Connection, give it a name and copy its API key into CIN7_OMNI_API_KEY.
4. Under Permissions tick Read for every resource the AI should see (and Create or Update for the write tools), then Save. A resource without permission answers 403.

The connector sends both as HTTP Basic authentication.

Where to start: cin7_omni_list_branches for branch ids, cin7_omni_list_sales_orders for recent orders, cin7_omni_list_stock for stock per branch, cin7_omni_list_contacts to find a customer or supplier.

Reading: sales cin7_omni_list_sales_orders, cin7_omni_get_sales_order, cin7_omni_list_quotes, cin7_omni_list_credit_notes, cin7_omni_get_credit_note, cin7_omni_list_payments; purchasing cin7_omni_list_purchase_orders, cin7_omni_get_purchase_order; catalogue cin7_omni_list_products, cin7_omni_get_product, cin7_omni_list_product_options, cin7_omni_list_product_categories; stock cin7_omni_list_stock, cin7_omni_list_adjustments, cin7_omni_list_branch_transfers; people cin7_omni_list_contacts, cin7_omni_get_contact, cin7_omni_list_users.

Writing: cin7_omni_create_sales_order, cin7_omni_update_sales_order (header fields only), cin7_omni_create_purchase_order, cin7_omni_create_contact, cin7_omni_update_contact, cin7_omni_create_branch_transfer. cin7_omni_create_adjustment is installed switched off because an approved adjustment changes stock value at once. Writes answer HTTP 200 with a list of {index, success, id, code, errors}: always check success and errors, a refused record still returns 200. Payments are read only: the connector never records, changes or deletes a payment, and it does not dispatch, invoice or void orders.

Filtering (where): SQL style on fields of the record, not of line items. Strings and dates in single quotes, numbers bare: modifiedDate>='2026-01-01T00:00:00Z' AND branchId=3, reference LIKE 'SO-10%', id IN (21,24). Dates are UTC, yyyy-MM-ddTHH:mm:ssZ. fields trims the answer (id,reference,total,lineItems(code,qty)); use it on order lists, which are large. order sorts, highest first unless you add ASC.

Paging: page starts at 1, rows is at most 250 (default 50 here, 25 on order lists). Ask for the next page until one comes back empty. For a sync, filter on modifiedDate and sort modifiedDate ASC.

Rate limits: Cin7 Omni allows 3 calls per second, 60 per minute and 5000 per day per account; beyond that it answers 429 with Retry-After. Prefer large rows with narrow where filters over many small calls.

Values: order status is DRAFT, APPROVED or VOID; stage is a free text workflow stage (New, Awaiting Payment, Processing, On Hold, Dispatched). Stock available is stock on hand minus open sales. Contact type is Customer, Supplier or Internal. Write amounts in the order currency; reads return base currency values with the exchange rate.