Get Started

The QuikOrder API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. API responses leverage JSON.

Set Up

Before using the QuikOrder Web Services API, you’ll need to set up a business account and obtain API credentials (client id, client secret, and provision key). Additional authorization information is needed for Client setup and will be provided separately. Contact support@quikorder.com for more information.

Authentication

The authentication is an OAuth 2 flow, beginning with the user authenticating with their QuikOrder credentials. The user then authorizes your app to connect to their QuikOrder network.The end result is a token that your app will use to write events to QuikOrder and retrieve QuikOrder data. Instructions for acquiring this token (will be provided separately).

Pricing

Contact us at: sales@quikorder.com for pricing information.

Sample Data Types


The API returns data in the JSON format, utilizing the native JSON data types whenever possible. The API accepts JSON input only: Content-Type: application/json

Boolean

  • The API returns only native boolean true or false values, without quotes.
  • This is the native boolean JSON type.

Number

  • Accepts integers
  • Ex: -2147483648 to +2147483647.

Date

  • The format is restricted ISO 860 Standard.
  • Only format accepted is YYYY-MM-DD. For example, 2013-04-03

Time

  • The API returns only native boolean true or false values, without quotes.
  • This is the native boolean JSON type.

Datetime

  • The format is restricted ISO 860 Standard.
  • Datetimes are a combined date and time in UTC timezone (Z is shorthand for UTC/Zulu): 2013-04-03T23:45Z
  • The datetime internally stored value is always in UTC. An input value that has an explicit time zone specified is converted to UTC using the appropriate offset for that time zone. If no time zone is stated in the input string, then it is assumed to be UTC.

Decimal

  • It does not matter if you post a decimal it as: '199.50' or 199.50.
  • The API always returns a decimal/float as a string.
  • Decimals will only contain as many significant digits as are available. If you supply 199.50 to a decimal w/2 places, the system will return to you 199.5.
  • If saving a value in the API whose decimal digits are greater than the precision available (e.g. 199.555 w/a field that has 2 digit precision), the system will round the value to the specified number of fractional digits (this is a postgres/SQL default). If 199.555 was requested, the stored value would be 199.56.
  • Be sure to understand floating point accuracy issues