Overview
The Order Time REST API allows you to write code that can add, delete, modify and query almost selected records in Order Time. For example:
- Create or modify customers and items.
- Create quotes and sales orders.
- Fill sales orders (i.e. create ship docs).
Before getting started with the API, your company's Master Admin must obtain an API key.
All end points for the API are located at https://services.ordertime.com/api
Headers
All requests must have the following headers:
- apiKey: The API key obtained above.
- email: The user's email which is used to establish the request's Role.
You can set up separate API users, with each user having distinct permissions. This approach is useful if you need a separate audit trail for each API connection. However, if an audit trail isn't a concern and you already have a regular user role like GM, Admin, or Sales, you could use a single user for multiple API connections.
- password: The user's password.
To avoid the need for using the individual user's password, as a developer for integrations with Order Time Inventory you can apply for a DevKey. The DevKey can be used instead in the header. All we do on our end is add those tenant companies to your DevKey and you are good to go. It provides us with reporting on who is using the integration and it provides you with a quick way to get them connected.
To apply for a DevKey, email contact@ordertime.com
Using the API is akin to using Order Time itself with respect to a user's role and what they can see or do.
IT IS RECOMMENDED THAT YOU CREATE A ROLE/USER FOR THE PURPOSES OF THIS API.
- For POST and PUT requests add the following header:
- Content-Type: application/json
Response Codes
| Code | Description |
| 200 | OK - Request succeeded, For Delete request, the return value will be true otherwise the return value will be the requested object. |
| 400 | Bad request. An error message will be returned in the response. |
| 403 | Forbidden - The user does not have role rights to perform the given request. |
| 409 | Conflicted - The request was well formed however the data submitted failed the server's data validation tests. The response will include and array of ValidationResult objects. |
Only Code 400 will generate an error so you should always check the response code.
Querying Data
Often, in using the API you will need to retrieve Lists of Objects. You first step therefore should be to review Working with Entity Refs and Lists.
Rate Limit
How Can We Retrieve More Than 1,000 Records in a Single Query from Order Time to Our Application Using the API?
- We do rate limiting so the server performance is not impacted so 1000 is the limit per query via API.
- You can however innumerate the pages for more than 1000 records.
