Documentation Powered by ReDoc

DataConnect (1.3.1.42)

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.

Authentication

bearerAuth

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

Release Notes for Data Connect can be found on the API Release Notes page.

Deltas

The DataConnect Delta documentation has moved, see DataConnect Deltas.

General

Ping

This unsecured endpoint returns the current API version of DataConnect

Responses

200

Successful Response

get /Ping

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Ping

Production

https://dataconnect.iqmetrix.net/Ping

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ApplicationName": "IQ.DataConnect.Web.WebApplication",
  • "ApplicationVersion": "1.3.0.51"
}

Get Session Information

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.

Authorizations:
bearerAuth
query Parameters
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 (Response=Json|Xml|Csv|Excel) or if it should include schema and business descriptions of data (Response=JsonDataTable|XmlDataTable) For Response=*.Email, the email will be sent from iQmetrix DataConnect Delivery Service noreply@iqmetrix.net with the report included as an attached file with the specified name.

CSV.Delimiter
string
Default: ","
Example: CSV.Delimiter=|

Used if Response=[Csv|Csv.Email]. If the response contains a string that also contains the delimiter the entire string is escaped in quotes.

CSV.FileExtension
string
Default: "csv"
Example: CSV.FileExtension=csv

Used if Response=[Csv|Csv.Email]. File extension

CSV.Headers
boolean
Default: true
Example: CSV.Headers=true

Used if Response=[Csv|Csv.Email]. A flag to indicate if CSV headers should be included

Email.To
string
Example: Email.To=recipient2@domain.com

Required if Response=[Csv|Excel|Xml].Email. Semicolon delimited list of emails to include as To

Email.Cc
string
Example: Email.Cc=recipient2@domain.com

Used if Response=[Csv|Excel|Xml].Email. Semicolon delimited list of emails to include as CC

Email.Subject
string
Example: Email.Subject=Test Data

Used if Response=[Csv|Excel|Xml].Email. The subject of the email. Defaults to the resource being requested with the current date.

Email.Compress
boolean
Default: false
Example: Email.Compress=false

Used if Response=[Csv|Excel|Xml].Email. A flag to indicate if the requested document should be compressed into a zip file (true) or not (false)

Filename
string
Example: Filename=MyReport

Used if Response=[Csv|Excel|Xml].Email. Defaults to the resource being requested with today's date

Responses

200

Successful Response

400

An error indicating a required parameter was not supplied.

413

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.

429

Rate/Resource Limiting Applied.

get /session

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/session

Production

https://dataconnect.iqmetrix.net/session

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_token": "2YotnFZFEjr1zCsicMWpAA",
  • "isValid": "true",
  • "ParentEntityId": "42",
  • "RQEmployeeId": "5121",
  • "PreferredEndpoint": "https://dataconnect10.iqmetrix.net",
  • "UserManagerEmployeeID": "280494",
  • "Username": "John.Bates@KENTEL"
}

Availability of Product

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.

Authorizations:
bearerAuth
query Parameters
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 LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see LocationTypeIDs.

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 AvailabilityofProduct_byLocation in the successful responses below for more information.

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 SerialNumbers

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 >= QuantityMin

QuantityMax
integer
Example: QuantityMax=5

When provided, will return products with Quantity <= QuantityMax

Responses

200

Successful Response

get /Availability/Product

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Availability/Product

Production

https://dataconnect.iqmetrix.net/Availability/Product

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Customers

This endpoint returns customer delta data for all customers. You can use the described Query Parameters below to refine your search.

Authorizations:
bearerAuth
query Parameters
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 LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see LocationTypeIDs.

StartDate
string <date>
Example: StartDate=2019-06-01

Initial date and time of the search period, filters based on LastUpdatedDate

StopDate
string <date>
Example: StopDate=2019-06-02

End date and time of the search period, filters based on LastUpdatedDate

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
  • 0: Company
  • 3: Individual
Phone
string
Example: Phone=5555555555

Phone of the customer

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