API V1 introduction

The latest version of the Cin7 Core API (V2) is available, with more advanced functionality and support for recent system changes. See the full API documentation to get started.

You need a Cin7 Core account before you can use the API. Trial accounts can also access the API.

Our List of Endpoints provides an overview of each endpoint in the Cin7 Core API V1. Migrate to Cin7 Core API V2 to access a wider range of endpoints. Each endpoint has its own article including the operations supported and the full list of available fields with a name, type, length, and required values.

The API URL is https://inventory.dearsystems.com/externalapi/. To call any API endpoint (method), you must append the endpoint name and parameters to the API URL, e.g. sample call - not a working link).

The API accepts only JSON data format.

Queue requests to the API so that you can retry the request in the event of a network failure. You should always plan to add all requests to a queue so that they can be tried again in the event of any failure.

In the event of errors, the API will return an appropriate HTML status code and an error message. You will need to read both the status code and the error message to establish the cause. Typical error messages are documented under the API Status Codes section of this knowledge base.

Was this article helpful?

Have more questions? Submit a request