Modified on: Tue, 5 Feb, 2019 at 2:32 PM
The DEAR Inventory API is part of DEAR Inventory web application at https://inventory.dearsystems.com. You will need to create an account there before you can use the API. Trial accounts are also allowed to access the API.
IMPORTANT! DEAR API V2 has been released! If you have been using DEAR API v1, please consider migrating to the V2 version as it has more advanced functionality and covers all recent system changes. You can find documentation for API V2 at https://dearinventory.docs.apiary.io/#.
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. https://inventory.dearsystems.com/externalapi/ProductAvailability&page=1&limit=100.
The API accepts only JSON data format.
Never assume that the API is actually online at any time. Always queue requests to the API so that you can retry the request in the event of a network failure: even if our server is up 24/7 forever, the network will not be. Consider what happens in the case of a network interruption, eg the cable gets cut by road workers yet again. You should always plan to add all requests to a queue so that they can be tried again in the event of any failure.
Full documentation of each endpoint is available on that endpoint's help page. This includes the operations supported and the full list of available fields with name, type, length and required values. A list of all endpoints is given in the "API Endpoints" topic. Use our API Explorer to see examples of each data object.
DEAR Inventory API is a subset of the functionality available through DEAR Inventory UI - check the API documentation to see if the functionality you require is available in the API.
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.
Did you find it helpful?
Sorry we couldn't be helpful. Help us improve this article with your feedback.