DataConnect is a web-based connector service you can use to extract data from iQmetrix by making simple HTTP requests. It provides endpoints for common data requirements, various auth mechanisms, and other utility endpoints.
DataConnect provides you a catalog of retailer data sets designed to meet your simple to complex reporting needs and is the perfect tool for your data analyst to quickly derive insights about your retail operations.
Found a Mistake?
We appreciate your patience as we work to improve the documentation for DataConnect. If you have noticed a mistake or have a qustion, please let us know at apisupport [at] iqmetrix [dot] com, subject "Documentation Issue".
Common Parameters
For a complete list of parameters that are accessible to all DataConnect endpoints, see Session endpoint.
Security Protocols
We recommend that users use TLS 1.2 when connecting to DataConnect.
Error Messages
DataConnect returns standard HTTP status codes (400, 401, 403, 404, 500, 503) and readable error messages. For an example of these messages see Session endpoint.
Sign Up
To signup, contact your account manager for pricing and onboarding with DataConnect.
Bearer token. See Obtaining an Access Token.
Once authenticated DataConnect will pass back a session cookie, this cookie should be provided on each subsequent data request to make use of your existing session for performance purposes.
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
Release Notes for Data Connect can be found on the API Release Notes page.
The DataConnect Delta documentation has moved, see DataConnect Deltas.
This unsecured endpoint returns the current API version of DataConnect
Successful Response
Release Candidate (RC)
Production
{- "ApplicationName": "IQ.DataConnect.Web.WebApplication",
- "ApplicationVersion": "1.3.0.51"
}
The following described parameters are common to every endpoint within DataConnect:
Response
CSV.Delimiter
CSV.FileExtension
CSV.Headers
Email.To
Email.Cc
Email.Subject
Email.Compress
Filename
The PreferredEndpoint
response property provides the URL you should use for each client for optimal results. While this usage is optional it is recommended for the lowest latency for processing requests.
Response | string Default: "Json" Enum: "Json" "JsonDataTable" "Xml" "XmlDataTable" "Csv" "Excel" "Excel.Email" "Csv.Email" "Xml.Email" Example: Response=JsonDataTable This parameter is available to all DataConnect endpoints. This dictates the type of response returned ( |
CSV.Delimiter | string Default: "," Example: CSV.Delimiter=| Used if |
CSV.FileExtension | string Default: "csv" Example: CSV.FileExtension=csv Used if |
CSV.Headers | boolean Default: true Example: CSV.Headers=true Used if |
Email.To | string Example: Email.To=recipient2@domain.com Required if |
Email.Cc | string Example: Email.Cc=recipient2@domain.com Used if |
Email.Subject | string Example: Email.Subject=Test Data Used if |
Email.Compress | boolean Default: false Example: Email.Compress=false Used if |
Filename | string Example: Filename=MyReport Used if |
Successful Response
An error indicating a required parameter was not supplied.
Row Limiting Applied.
For some endpoints this guard attempts to estimate the number of records that will be returned on a request. If greater than 1,048,576 (Matches row limit for Microsoft Excel) records would be returned the request is blocked.
Rate/Resource Limiting Applied.
Release Candidate (RC)
Production
{- "access_token": "2YotnFZFEjr1zCsicMWpAA",
- "isValid": "true",
- "ParentEntityId": "42",
- "RQEmployeeId": "5121",
- "UserManagerEmployeeID": "280494",
- "Username": "John.Bates@KENTEL"
}
This endpoint returns availability information for all products configured in RQ. You can use the described Query Parameters below to refine your search.
Note: If the Query Parameters LocationType
and LocationTypeID
are not included in the API call, the response will not include LocationId
. See the documented response schemas below for more information.
LocationType | string Example: LocationType=Company When provided, will filter based on the Location Tree. For a list of acceptable values, see LocationType. |
LocationTypeIDs | integer Default: "-1" Example: LocationTypeIDs=100101 Will filter based on the ID(s) within the Company Tree level indicated in |
ProductType | string Enum: "Serialized" "Non-Serialized" Example: ProductType=Serialized Type of product according to serialization |
ByLocation | boolean Default: false Example: ByLocation=true A flag to indicate if the results should return location information. See |
ProductSKUs | string Example: ProductSKUs=ACPHLG000135,ACPHRI000170,ASBOLG000012 Comma-separated list of Product SKUs. For a list of acceptable values, see Product Identifier. |
CatalogItemIDs | string <guid> Example: CatalogItemIDs=a183f1a9-c58f-426a-930a-9a6357db52ed Comma-separated list of identifiers for products in the iQmetrix Catalog API. |
ProductLibraryIDs | string Example: ProductLibraryIDs=M12512,M55321 Comma-separated list of identifiers for Products in the iQmetrix Product Library |
ProductNames | string Example: ProductNames=iPhone XS Max 128 GB Comma-separated list of Product Names |
SerialNumbers | string Example: SerialNumbers=1234343434 Comma-separated list of |
BarCodes | string Example: BarCodes=822445090459 Comma-separated list of Bar Codes |
VendorSKUs | string Example: VendorSKUs=6025A_POIIU Comma separated list of Vendor identifiers |
QuantityMin | integer Example: QuantityMin=1 When provided, will return products with Quantity >= |
QuantityMax | integer Example: QuantityMax=5 When provided, will return products with Quantity <= |
Successful Response
Release Candidate (RC)
Production
[- {
- "CatalogItemID": "c10070b6-8bc1-4282-b5de-4afe5c8d7b9d",
- "ProductLibraryID": "M1285-V1-E13202",
- "ProductName": "Google Nexus 5 16GB - Black",
- "ProductSKU": "ACPHLG000135",
- "VendorSKU": "FWT33623-53",
- "ProductType": "Serialized",
- "Quantity": 4452,
- "InStock": true,
- "MinQty": 20,
- "MaxQty": 85
}
]
This endpoint returns customer delta data for all customers. You can use the described Query Parameters below to refine your search.
LanguageCode | string Default: "en-us" Example: LanguageCode=en-us For an updated list of acceptable values, see Languages. |
LocationType | string Example: LocationType=Company When provided, will filter based on the Location Tree. For a list of acceptable values, see LocationType. |
LocationTypeIDs | integer Default: "-1" Example: LocationTypeIDs=100101 Will filter based on the ID(s) within the Company Tree level indicated in |
StartDate | string <date> Example: StartDate=2019-06-01 Initial date and time of the search period, filters based on |
StopDate | string <date> Example: StopDate=2019-06-02 End date and time of the search period, filters based on |
EmployeeID | string Example: EmployeeID=64326 Internal identifier of the employee associated with the Customer. For a list of acceptable values, see Employees. |
CustomerEntityID | string <guid> Example: CustomerEntityID=a08b0640-606a-41f0-901a-facaf50e75dd Unique identifier for a Customer in the iQmetrix CRM API. |
CustomerID | string Example: CustomerID=51231 Internal identifier of the customer in RQ. |
PrimaryName | string Example: PrimaryName=Jane First name of the customer |
FamilyName | string Example: FamilyName=Doe Last name of the customer |
CompanyName | string Example: CompanyName=Kentel Company name |
CustomerTypeID | integer Enum: 0 3 Example: CustomerTypeID=0
|
Phone | string Example: Phone=5555555555 Phone of the customer |
string Example: Email=test@test.com Email of the customer | |
RowThumbprint | string <guid> Example: RowThumbprint=38dc37d2-853a-4343-8518-93a44989243a Unique identifier of a thumbprint |
MemberNumber< |