Introduction
AutoQuotes Order Status API provides aggregated order status data from all Manufacturers in one place, allowing Dealers and Reps to track all of their orders in AutoQuotes. All parties involved benefit from the time, and in turn money, saved by reducing customer service calls and emails. The AutoQuotes Order Status API allows companies direct access to this aggregated order status data for use in their backend systems.
The HTTP Endpoint
The AutoQuotes Order Status API is a RESTful API, and data is transferred as JSON. To learn more, see Introducing JSON
The full HTTP endpoint has the following format, where the value of after must be supplied with a date in the form of MM-DD-YYYY
https://api-autoquotes.azurewebsites.net/api/orders?after={date}
Example
https://api-autoquotes.azurewebsites.net/api/orders?after=03-14-2015
Security And Authentication
This is an SSL-only API. You must be a verified user to make API requests. You must authorize against the API using an API key as an authorization token.
API Token
API tokens are managed in the AutoQuotes Admin interface at Admin Settings > API Keys. The page lets you view, add, or delete tokens. More than one token can be active at the same time. Deleting a token deactivates it permanently.
Instructions for generating the API key can be found here.
Instructions for generating the API key can be found here.
Initial Request
The request header must include your API key as an authorization token, and a region specified as AQR for US orders, or CQR for UK orders.
curl -H "Authorization-Token: {apiKey}" -H "aq-region: {region}" https://api-autoquotes.azurewebsites.net/api/orders?after= {date}
Example
curl -H "Authorization-Token: {apiKey}" -H "aq-region: AQR" https://api-autoquotes.azurewebsites.net/api/orders?after= 03-14-2015
Response
The response will contain a JSON object with three properties.
- @moreAvailable is a boolean that indicates if there are more results to download. i.e. true/false
- @queryId is an integer that is used to obtain more results
- orders contains JSON objects for the changes orders
Example
{
"@moreAvailable": true,
"@queryId": 42,
"orders": [],
}
"@moreAvailable": true,
"@queryId": 42,
"orders": [],
}
The JSON schema for order data can be downloaded here.
Follow Up Request
If @moreAvailable is true, make a follow-up request to the service using the following format.
curl -H "Authorization-Token: {apiKey}" -H "aq-region: {region}" https://api-autoquotes.azurewebsites.net/api/orders?queryId= {@queryId}
Example
curl -H "Authorization-Token: {apiKey}" -H "aq-region: AQR" https://api-autoquotes.azurewebsites.net/api/orders?queryId= 42
Comments
0 comments
Article is closed for comments.