Order Time REST API

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 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.

password: The user's password. 

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 RECOMPONED 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

CodeDescription
200OK - Request succeeded,   For Delete request, the return value will be true otherwise the return value will be the requested object.
400Bad request.  An error message will be returned in the response.
403Forbidden - The user does not have role rights to perform the given request.
409Conflicted - 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.