The iQuoteXpress (IQX) REST API is a series of methods that will allow IQX system users to build their own integrations with third-party applications. These applications will share Accounts, Contacts, Products, and Quotes information with IQX.
In order to build your integration, you must have an existing Admin account to iQuoteXpress. Please contact our sales team if you need more information, at sales@iquotexpress.com.
v1.0.0
The API URI:
http://sys01.iquotexpress.com/iqxAPI_rest/EndPoint/Request will allow you to make several calls and request to system. Refer to the below EndPoint list for the Modules and the methods sections will give you specific examples on how to make calls to your environment.
| Name | EndPoint | Description |
|---|---|---|
| User | iQxAPI_rest/Api/User | Provides end user/client application session management. Invoking the login method is required to obtain an Access Token that must be included in the authorization header of all subsequent requests. |
| Account | iQxAPI_rest/Api/Account | Provides CRUD methods to manage customer accounts |
| Contact | iQxAPI_rest/Api/Contact | Provides CRUD methods to manage customer contacts |
| Item | iQxAPI_rest/Api/Item | Provides CRUD methods to manage the items within the catalog |
| ItemBrand | iQxAPI_rest/Api/ItemBrand | Provides CRUD methods to manage the item brands within the catalog |
| ItemCategory | iQxAPI_rest/Api/ItemCategory | Provides CRUD methods to manage the item categories within the catalog |
| ItemRelationships | iQxAPI_rest/Api/ItemRelationships | Provides CRUD methods to manage item relationships |
| Catalog | iQxAPI_rest/Api/Catalog | Provides methods to navigate both the catalog and the library, drilling down the categories step by step until reaching the item level. |
| Quote | iQxAPI_rest/Api/Quote | Provides CRUD methods to manage proposals |
| QuoteItems | iQxAPI_rest/Api/QuoteItems | Provides CRUD methods to manage proposal line items |
| QuoteSections | iQxAPI_rest/Api/QuoteSections | Provides CRUD methods to mange proposal sections |
In order to obtain a token you need to have a valid iQx admin user account. The user name and password will be required as part of the request to obtain the SSID token .
| API | Description | |
|---|---|---|
| POST Api/User/Login | Authenticates an iQx user on behalf of a registered client application | |
| POST Api/User/Logout | Closes the current user session | |
| API | Description |
|---|---|
| GET Api/Account/Get | Returns account information for the given id |
| GET Api/Account/List | Returns list of accounts matching the given criteria |
| POST Api/Account/Query | Returns selected account columns matching the given where clause |
| POST Api/Account/Create | Creates a new account |
| POST Api/Account/Update | Updates the given account id |
| POST Api/Account/Delete | Deletes the given account id |
| API | Description |
|---|---|
| GET Api/Contact/Get | Returns contact information for the given id |
| GET Api/Contact/List | Returns list of contacts matching the given criteria |
| POST Api/Contact/Query | Returns selected contact columns matching the given where clause |
| POST Api/Contact/Create | Creates a new contact |
| POST Api/Contact/Update | Updates the given contact id |
| POST Api/Contact/Delete | Deletes the given contact id |
| API | Description |
|---|---|
| GET Api/Item/Get | Returns Item information for the given id |
| GET Api/Item/List | Returns list of Items matching the given criteria |
| POST Api/Item/Query | Returns selected Item columns matching the given where clause |
| POST Api/Item/Create | Creates a new Item |
| POST Api/Item/Update | Updates the given Item id |
| POST Api/Item/Delete | Deletes the given Item id |
| API | Description |
|---|---|
| GET Api/ItemBrand/Get | Returns brand information for the given id |
| GET Api/ItemBrand/List | Returns list of brands matching the given criteria |
| POST Api/ItemBrand/Query | Returns selected brand columns matching the given where clause |
| POST Api/ItemBrand/Create | Creates a new brand |
| POST Api/ItemBrand/Update | Updates the given brand id |
| POST Api/ItemBrand/Delete | Deletes the given brand id |
| API | Description |
|---|---|
| GET Api/ItemCategory/Get | Returns category information for the given id |
| GET Api/ItemCategory/List | Returns list of categories matching the given criteria |
| POST Api/ItemCategory/Query | Returns selected category columns matching the given where clause |
| POST Api/ItemCategory/Create | Creates a new category |
| POST Api/ItemCategory/Update | Updates the given category id |
| POST Api/ItemCategory/Delete | Deletes the given category id |
| API | Description |
|---|---|
| GET Api/ItemRelationships/Get | Returns information for the given relationship id |
| GET Api/ItemRelationships/List | Returns list of item relationships matching the given criteria |
| POST Api/ItemRelationships/Query | Returns selected item relationship columns matching the given where clause |
| POST Api/ItemRelationships/Create | Creates a new item relationship record |
| POST Api/ItemRelationships/Update | Updates the given item relationship record id |
| POST Api/ItemRelationships/Delete | Deletes the given item relationship record id |
| API | Description |
|---|---|
| GET Api/Catalog/List | Returns list of either child categories or child items corresponding to the given parent category id and list criteria |
| API | Description |
|---|---|
| GET Api/Quote/Get | Returns Quote information for the given id |
| GET Api/Quote/List | Returns list of Quotes matching the given criteria |
| POST Api/Quote/Query | Returns selected Quote columns matching the given where clause |
| POST Api/Quote/Create | Creates a new Quote |
| POST Api/Quote/Update | Updates the given Quote id |
| POST Api/Quote/Clone | Clones the given Quote id. The result is a new quote |
| POST Api/Quote/NewRevision | Creates a new revision for the given Quote id |
| POST Api/Quote/Delete | Deletes the given Quote id |
| API | Description |
|---|---|
| GET Api/QuoteItems/Get | Returns information for the given quote line |
| GET Api/QuoteItems/List | Returns list of quote line items matching the given criteria |
| POST Api/QuoteItems/Query | Returns selected quote line item columns matching the given where clause |
| POST Api/QuoteItems/Create | Creates a new quote line item |
| POST Api/QuoteItems/Update | Updates the given quote line item |
| POST Api/QuoteItems/Delete | Deletes the given quote line item |
| API | Description |
|---|---|
| GET Api/QuoteSections/Get | Returns information for the given quote section id |
| GET Api/QuoteSections/List | Returns list of quote sections matching the given criteria |
| POST Api/QuoteSections/Query | Returns selected quote section columns matching the given where clause |
| POST Api/QuoteSections/Create | Creates a new quote section |
| POST Api/QuoteSections/Update | Updates the given quote section id |
| POST Api/QuoteSections/Delete | Deletes the given quote section id |
