API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

To get started, see Data Connect Guide.

Note

For reports that provide optional URI parameters for filtering at different levels (ForWho/ForWhoIDs/LocationType/LocationTypeIDs), omitting these values will run the report at the default company level.

Authentication

This API supports many different methods of authentication, see Authentication Options.

Rate Limiting

Example

HTTP 429 Too Many Requests
{
    "Error": true,
    "Message": "Rate Limiting Applied. 8 active requests are already in progress."
}

Data Connect limits the number of concurrent requests you can perform per RQ Database.

If the rate limit is exceeded, the response will be HTTP 429 and you will not be able to make additional requests until a previously made request finishes.

ENDPOINTS

RESOURCES

GenerateMarketingReportData

[
    {
        "Customer Address": "3811 Smith Street",
        "Customer NAME": "John Tester",
        "Customer Zip Code": "75219",
        "Email": "johnb@test.com",
        "Employee Name": "IQMETRIX USER",
        "External Store ID": "2356",
        "GlobalProductID": 92,
        "Gross Profit": 19.99,
        "Id_number": 1421,
        "IMEI": "6783584733",
        "Member Number": "5103830",
        "MobileNumber": "6783584733",
        "Product Cost": 0,
        "Quantity": 1,
        "RQ Employee ID": 138,
        "RQ Invoice": "FAIVGIN569",
        "RQ Product Description": "IDEN -TELENAV: UNLIMITED ROUTES $10 -- NEED DATA ACCESS PLAN",
        "RQ SKU": "CANXRB000072",
        "Selling Price": 19.99,
        "Transaction Date": "2016-02-04T14:38:43.753"
    }
]
Name Description
Customer Address (VARCHAR(50)) Customer address
Customer NAME (VARCHAR(101)) Customer name
Customer Zip Code (VARCHAR(15)) Customer zip code
Email (VARCHAR(200)) Customer email
Employee Name (VARCHAR(51)) Employee name
External Store ID (VARCHAR(255)) Identifier for a location in an external system
GlobalProductID (INTEGER) Identifier for a Product in RQ
Gross Profit (MONEY) Gross profit
Id_number (INTEGER) Identifier for customer in RQ
IMEI (VARCHAR(100)) IMEI
Member Number (VARCHAR(50)) Customer member number
MobileNumber (VARCHAR(200)) Customer mobile number
Product Cost (MONEY) Product cost
Quantity (INTEGER) Quantity
RQ Employee ID (INTEGER) Identifier for an employee in RQ
RQ Invoice (VARCHAR(14)) Identifier for an invoice in RQ
RQ Product Description (NVARCHAR(MAX)) Description for a product in RQ
RQ SKU (VARCHAR(12)) Product SKU in RQ
Selling Price (MONEY) Selling price
Transaction Date (DateTime) Transaction date

ProductDetailReportData

[
    {
        "Activation_RowID": "d3d65281-5201-4927-9bac-6f3a47ddf56b",
        "AdjustedUnitPrice": 25,
        "CarrierPrice": null,
        "CategoryPath": ">> Phones >> Galaxies",
        "ChannelName": "English Channel",
        "Comments": "",
        "ContractNumber": "12345",
        "CustomerID": 131149,
        "CustomerName": "Bob Jones",
        "DateCreated": "2016-05-13T12:18:08.723",
        "DistrictName": "Westminster",
        "EmployeeName": "iQmetrix User",
        "GlobalProductID": 5179,
        "InvoicedAt": "100: My Network LLC - Anchorage",
        "InvoicedBy": "100: My Network LLC - Anchorage",
        "InvoiceIDByStore": "77224IN3",
        "IsOrderServiceDropShipProduct": null,
        "IsOrderServiceShippingProduct": null,
        "ListPrice": 449.95,
        "OriginalUnitPrice": 25,
        "Priority": 1,
        "ProductCouponDiscount": 0,
        "ProductIdentifier": "ASHCSA000120",
        "ProductName": "Samsung Galaxy Rugby LTE",
        "Quantity": 1,
        "Refund": 0,
        "RegionName": "London",
        "RetailerCatalogID": "null",
        "SaleInvoice_RowID": "8c6537ae-75a5-4155-82b2-c8647ed05f3d",
        "SaleInvoiceID": 128962,
        "SaleInvoiceProduct_RowID": "0099b78f-ba02-4a91-afd4-2f7eb0fbbb06",
        "SerialNumber": "1111111",
        "SoldAsUsed": false,
        "SpecialProductID": 0,
        "StoreInStoreFlowIsEnabledForStore": false,
        "StoreInStoreGrossProfit": null,
        "StoreInStoreListPrice": null,
        "StoreInStorePrice": null,
        "StoreTypeName": "Costco",
        "TenderedBy": "iQmetrix User",
        "TotalCost": 0,
        "TotalDiscount": 424.95,
        "TotalPrice": 25,
        "UnitCost": 0,
        "UnitPrice": 25,
        "VendorName": "",
        "VendorSKU": ""
    }
]
Name Description
Activation_RowID (UNIQUEIDENTIFIER) Internal identifier in RQ
AdjustedUnitPrice (MONEY) Adjusted Unit Price - price that the product was actually sold for
CarrierPrice (MONEY) Carrier Price - value or revenue that a carrier assigns this feature
CategoryPath (NVARCHAR(MAX)) Category - the category the product belongs to
ChannelName (NVARCHAR(MAX)) Channel - channel for the rows location
Comments (TEXT) Invoice Comments - comments added to the invoice
ContractNumber (VARCHAR (50)) Contract # - number of the contract, recorded at the time of sale
CustomerID (INT) Internal identifier for a customer in RQ
CustomerName (VARCHAR (101)) Customer - name of the customer as entered on their profile
DateCreated (DateTime) Sold On - date and time the invoice was tendered
DistrictName (NVARCHAR(MAX)) District - district for the rows location
EmployeeName (VARCHAR (51)) Sold By - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box
GlobalProductID (INT) Internal identifier in RQ
InvoicedAt (NVARCHAR(MAX)) Invoiced At - name of the location which takes the inventory on a refund, usually the same as Invoiced By but will be different if a second location process a refund
InvoicedBy (NVARCHAR(MAX)) Invoiced By - name of the location which credited with the sale, usually the same as Invoiced At but will be different if a second location process a refund
InvoiceIDByStore (VARCHAR (14)) Invoice # - invoice number assigned by RQ
IsOrderServiceDropShipProduct (BIT) Internal identifier in RQ
IsOrderServiceShippingProduct (BIT) Internal identifier in RQ
ListPrice (MONEY) List Price - current price as noted on the pricing tab in the inventory console for the product
OriginalUnitPrice (MONEY) Orig. Unit Price - original price on the invoice
Priority (INT) The order that the products were saved in on an Invoice
ProductCouponDiscount (MONEY) Coupon discount on the product
ProductIdentifier (VARCHAR(12)) Product SKU - the RQ generated SKU
ProductName (NVARCHAR(MAX)) Product Name - name of the product as it appears in the inventory
Quantity (INT) Qty - total number of times the Product SKU appears on the invoice
Refund (BIT) Refund - indicates if a negative quantity of this item was sold
RegionName (NVARCHAR(MAX)) Region - region for the rows location
RetailerCatalogID (VARCHAR (50)) Internal identifier in RQ
SaleInvoice_RowID (UNIQUEIDENTIFIER) Internal identifier in RQ
SaleInvoiceID (INT) Identifier for an invoice in RQ
SaleInvoiceProduct_RowID (UNIQUEIDENTIFIER) Internal identifier in RQ
SerialNumber (VARCHAR (100)) Tracking # - tracking number associated with this product, serialized products only
SoldAsUsed (BIT) Sold As Used - indicates the product was used when sold
SpecialProductID (INT) Internal identifier in RQ
StoreInStoreFlowIsEnabledForStore (BIT) Internal identifier in RQ
StoreInStoreGrossProfit (MONEY) SIS Gross Profit - profit, calculated as Total Sales - Cost for a SIS location.
StoreInStoreListPrice (MONEY) SIS List Price - Price from the store-in-store setup of the product
StoreInStorePrice (MONEY) SIS Price - The default price when sold through the store-in-store flow
StoreTypeName (NVARCHAR(MAX)) Location Type - the location type the the transaction was performed at
TenderedBy (VARCHAR (51)) Tendered By - name of the employee logged into RQ when the invoice was tendered
TotalCost (MONEY) Total Cost - total purchase cost for the product(s) on the invoice
TotalDiscount (DECIMAL (8, 4)) Total Discount - net discount amount for the Product SKU on the particular invoice
TotalPrice (MONEY) Total Sales - net dollar amount for the Product SKU on the particular invoice
UnitCost (MONEY) Unit Cost - purchase cost per unit
UnitPrice (MONEY) Sold For - price that appeared on the invoice (including hide on invoice items), i.e. negative if a refund
VendorName (NVARCHAR(MAX)) Name for a vendor in RQ
VendorSKU (VARCHAR(25)) Vendor SKU

ProductDetailReportTaxColumnData

[
    {
        "ColName": "T102",
        "ColCaption": "Flat tax",
        "CreditCardPaymentType": "null"
    }
]
Name Description
ColName (VARCHAR) Tax name
ColCaption (NVARCHAR(MAX)) Description
CreditCardPaymentType (VARCHAR (20)) Credit card information

ProductDetailReportTaxDetailData

[
    {
        "Amount": 22.5,
        "GlobalProductID": 5179,
        "Priority": 1,
        "SaleInvoiceID": 128996,
        "SerialNumber": "2222222",
        "TaxID": "T102",
        "TaxName": "Brad flat tax"
    }
]
Name Description
Amount (MONEY ) Amount
GlobalProductID (INT) Identifier of a Product in RQ
Priority (INT) Priority
SaleInvoiceID (INT) Identifier of a sale invoice in RQ
SerialNumber (VARCHAR (100) ) Serial number
TaxID (VARCHAR) Tax identifier
TaxName (NVARCHAR(MAX)) Tax name

Relationship

[
    {
        "CompanyID": 21090,
        "CompanyName": "KENTEL",
        "DoingBusinessAs": "Kentel Corp"
    }
]
Name Description
CompanyID (INTEGER) Identifier for a Company
CompanyName (VARCHAR(50)) Database name
DoingBusinessAs (NVARCHAR(MAX)) Company name

DealerRelationship

[
    {
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "LocationEntityID": 14192,
        "LocationName": "Region A"
    }
]
Name Description
CompanyID (BIGINT) Identifier for a Company
CompanyName (NVARCHAR(128)) Company name
LocationEntityID (BIGINT) Identifier for the Location, Region, Channel or District in Entity Store
LocationName (NVARCHAR(MAX)) Name of the Location, Region, Channel or District

REQUESTS

GET Dealer Relationships

This request returns a list of LocationEntityIDs and Names for a Company that the partner can access.

When the response contains multiple resouces with the same CompanyID, the partner can access multiple nodes within the Company.

Example

The below response means the partner can access data on behalf of the company KENTEL using the context of Region 1 (LocationEntityID 14189) or Region 2 (LocationEntityID 14188).

{
  "CompanyID": 14146,
  "CompanyName": "MasterCompany",
  "LocationEntityID": 14189,
  "LocationName": "Child Dealer 1"
},
{
  "CompanyID": 14146,
  "CompanyName": "MasterCompany",
  "LocationEntityID": 14188,
  "LocationName": "Child Dealer 2"
}

Definition

GET /partner/relationships/dealers?Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/relationships/dealers
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingDealerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingDealerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[DealerRelationship]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "LocationEntityID": 14192,
        "LocationName": "Region A"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CompanyID": 14146,
            "CompanyName": "KENTEL",
            "LocationEntityID": 14192,
            "LocationName": "Region A"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>14146</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <LocationEntityID>14192</LocationEntityID>
    <LocationName>Region A</LocationName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CompanyID,CompanyName,LocationEntityID,LocationName
14146,KENTEL,14192,Region A

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Partner Relationships

This request will return a list of Companies the Partner can access data from.

If the response is empty, use the request Getting Dealer Relationships instead.

Definition

GET /partner/relationships?Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/relationships
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPartnerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingPartnerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/relationships', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Relationship]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CompanyID": 21090,
        "CompanyName": "KENTEL",
        "DoingBusinessAs": "Kentel Corp"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CompanyID": 21090,
            "CompanyName": "KENTEL",
            "DoingBusinessAs": "Kentel Corp"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>21090</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <DoingBusinessAs>Kentel Corp</DoingBusinessAs>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CompanyID,CompanyName,DoingBusinessAs
21090,KENTEL,Kentel Corp

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

Generate Marketing Report

Definition

GET /partner/Chatterspot/GenerateMarketingReport?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&OverrideReportDefaultDate={OverrideReportDefaultDate}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Chatterspot/GenerateMarketingReport?CompanyId=14682&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&OverrideReportDefaultDate=1970-01-01T06:00:00.000Z
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/GenerateMarketingReport?CompanyId=14682&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&OverrideReportDefaultDate=1970-01-01T06:00:00.000Z" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GenerateMarketingReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/GenerateMarketingReport?CompanyId=14682&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&OverrideReportDefaultDate=1970-01-01T06:00:00.000Z");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GenerateMarketingReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/GenerateMarketingReport?CompanyId=14682&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&OverrideReportDefaultDate=1970-01-01T06:00:00.000Z");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/GenerateMarketingReport?CompanyId=14682&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&OverrideReportDefaultDate=1970-01-01T06:00:00.000Z', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GenerateMarketingReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Customer Address": "3811 Smith Street",
        "Customer NAME": "John Tester",
        "Customer Zip Code": "75219",
        "Email": "johnb@test.com",
        "Employee Name": "IQMETRIX USER",
        "External Store ID": "2356",
        "GlobalProductID": 92,
        "Gross Profit": 19.99,
        "Id_number": 1421,
        "IMEI": "6783584733",
        "Member Number": "5103830",
        "MobileNumber": "6783584733",
        "Product Cost": 0,
        "Quantity": 1,
        "RQ Employee ID": 138,
        "RQ Invoice": "FAIVGIN569",
        "RQ Product Description": "IDEN -TELENAV: UNLIMITED ROUTES $10 -- NEED DATA ACCESS PLAN",
        "RQ SKU": "CANXRB000072",
        "Selling Price": 19.99,
        "Transaction Date": "2016-02-04T14:38:43.753"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Customer Address": "3811 Smith Street",
            "Customer NAME": "John Tester",
            "Customer Zip Code": "75219",
            "Email": "johnb@test.com",
            "Employee Name": "IQMETRIX USER",
            "External Store ID": "2356",
            "GlobalProductID": 92,
            "Gross Profit": 19.99,
            "Id_number": 1421,
            "IMEI": "6783584733",
            "Member Number": "5103830",
            "MobileNumber": "6783584733",
            "Product Cost": 0,
            "Quantity": 1,
            "RQ Employee ID": 138,
            "RQ Invoice": "FAIVGIN569",
            "RQ Product Description": "IDEN -TELENAV: UNLIMITED ROUTES $10 -- NEED DATA ACCESS PLAN",
            "RQ SKU": "CANXRB000072",
            "Selling Price": 19.99,
            "Transaction Date": "2016-02-04T14:38:43.753"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Customer Address>3811 Smith Street</Customer Address>
    <Customer NAME>John Tester</Customer NAME>
    <Customer Zip Code>75219</Customer Zip Code>
    <Email>johnb@test.com</Email>
    <Employee Name>IQMETRIX USER</Employee Name>
    <External Store ID>2356</External Store ID>
    <GlobalProductID>92</GlobalProductID>
    <Gross Profit>19.99</Gross Profit>
    <Id_number>1421</Id_number>
    <IMEI>6783584733</IMEI>
    <Member Number>5103830</Member Number>
    <MobileNumber>6783584733</MobileNumber>
    <Product Cost>0</Product Cost>
    <Quantity>1</Quantity>
    <RQ Employee ID>138</RQ Employee ID>
    <RQ Invoice>FAIVGIN569</RQ Invoice>
    <RQ Product Description>IDEN -TELENAV: UNLIMITED ROUTES $10 -- NEED DATA ACCESS PLAN</RQ Product Description>
    <RQ SKU>CANXRB000072</RQ SKU>
    <Selling Price>19.99</Selling Price>
    <Transaction Date>2016-02-04T14:38:43.753</Transaction Date>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Customer Address,Customer NAME,Customer Zip Code,Email,Employee Name,External Store ID,GlobalProductID,Gross Profit,Id_number,IMEI,Member Number,MobileNumber,Product Cost,Quantity,RQ Employee ID,RQ Invoice,RQ Product Description,RQ SKU,Selling Price,Transaction Date
3811 Smith Street,John Tester,75219,johnb@test.com,IQMETRIX USER,2356,92,19.99,1421,6783584733,5103830,6783584733,0,1,138,FAIVGIN569,IDEN -TELENAV: UNLIMITED ROUTES $10 -- NEED DATA ACCESS PLAN,CANXRB000072,19.99,2016-02-04T14:38:43.753

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Product Detail Report for a Company

For more information, see Product Detail Report.

Note that this report has multiple responses, depending on the ReportPart specified.

Report Part Response
1 ProductDetailReportData
2 ProductDetailReportTaxDetailData
3 ProductDetailReportTaxColumnData

Definition

GET /partner/Chatterspot/ProductDetailReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&CategoryNumber={CategoryNumber}&ReportPart={ReportPart}&ManufacturerID={ManufacturerID}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ProductIdentifier={ProductIdentifier}&InvoiceIDByStore={InvoiceIDByStore}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Chatterspot/ProductDetailReport?CompanyId=14682&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/ProductDetailReport?CompanyId=14682&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheProductDetailReportForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/ProductDetailReport?CompanyId=14682&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheProductDetailReportForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/ProductDetailReport?CompanyId=14682&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/Chatterspot/ProductDetailReport?CompanyId=14682&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ProductDetailReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Activation_RowID": "d3d65281-5201-4927-9bac-6f3a47ddf56b",
        "AdjustedUnitPrice": 25,
        "CarrierPrice": null,
        "CategoryPath": ">> Phones >> Galaxies",
        "ChannelName": "English Channel",
        "Comments": "",
        "ContractNumber": "12345",
        "CustomerID": 131149,
        "CustomerName": "Bob Jones",
        "DateCreated": "2016-05-13T12:18:08.723",
        "DistrictName": "Westminster",
        "EmployeeName": "iQmetrix User",
        "GlobalProductID": 5179,
        "InvoicedAt": "100: My Network LLC - Anchorage",
        "InvoicedBy": "100: My Network LLC - Anchorage",
        "InvoiceIDByStore": "77224IN3",
        "IsOrderServiceDropShipProduct": null,
        "IsOrderServiceShippingProduct": null,
        "ListPrice": 449.95,
        "OriginalUnitPrice": 25,
        "Priority": 1,
        "ProductCouponDiscount": 0,
        "ProductIdentifier": "ASHCSA000120",
        "ProductName": "Samsung Galaxy Rugby LTE",
        "Quantity": 1,
        "Refund": 0,
        "RegionName": "London",
        "RetailerCatalogID": "null",
        "SaleInvoice_RowID": "8c6537ae-75a5-4155-82b2-c8647ed05f3d",
        "SaleInvoiceID": 128962,
        "SaleInvoiceProduct_RowID": "0099b78f-ba02-4a91-afd4-2f7eb0fbbb06",
        "SerialNumber": "1111111",
        "SoldAsUsed": false,
        "SpecialProductID": 0,
        "StoreInStoreFlowIsEnabledForStore": false,
        "StoreInStoreGrossProfit": null,
        "StoreInStoreListPrice": null,
        "StoreInStorePrice": null,
        "StoreTypeName": "Costco",
        "TenderedBy": "iQmetrix User",
        "TotalCost": 0,
        "TotalDiscount": 424.95,
        "TotalPrice": 25,
        "UnitCost": 0,
        "UnitPrice": 25,
        "VendorName": "",
        "VendorSKU": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Activation_RowID": "d3d65281-5201-4927-9bac-6f3a47ddf56b",
            "AdjustedUnitPrice": 25,
            "CarrierPrice": null,
            "CategoryPath": ">> Phones >> Galaxies",
            "ChannelName": "English Channel",
            "Comments": "",
            "ContractNumber": "12345",
            "CustomerID": 131149,
            "CustomerName": "Bob Jones",
            "DateCreated": "2016-05-13T12:18:08.723",
            "DistrictName": "Westminster",
            "EmployeeName": "iQmetrix User",
            "GlobalProductID": 5179,
            "InvoicedAt": "100: My Network LLC - Anchorage",
            "InvoicedBy": "100: My Network LLC - Anchorage",
            "InvoiceIDByStore": "77224IN3",
            "IsOrderServiceDropShipProduct": null,
            "IsOrderServiceShippingProduct": null,
            "ListPrice": 449.95,
            "OriginalUnitPrice": 25,
            "Priority": 1,
            "ProductCouponDiscount": 0,
            "ProductIdentifier": "ASHCSA000120",
            "ProductName": "Samsung Galaxy Rugby LTE",
            "Quantity": 1,
            "Refund": 0,
            "RegionName": "London",
            "RetailerCatalogID": "null",
            "SaleInvoice_RowID": "8c6537ae-75a5-4155-82b2-c8647ed05f3d",
            "SaleInvoiceID": 128962,
            "SaleInvoiceProduct_RowID": "0099b78f-ba02-4a91-afd4-2f7eb0fbbb06",
            "SerialNumber": "1111111",
            "SoldAsUsed": false,
            "SpecialProductID": 0,
            "StoreInStoreFlowIsEnabledForStore": false,
            "StoreInStoreGrossProfit": null,
            "StoreInStoreListPrice": null,
            "StoreInStorePrice": null,
            "StoreTypeName": "Costco",
            "TenderedBy": "iQmetrix User",
            "TotalCost": 0,
            "TotalDiscount": 424.95,
            "TotalPrice": 25,
            "UnitCost": 0,
            "UnitPrice": 25,
            "VendorName": "",
            "VendorSKU": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Activation_RowID>d3d65281-5201-4927-9bac-6f3a47ddf56b</Activation_RowID>
    <AdjustedUnitPrice>25</AdjustedUnitPrice>
    <CarrierPrice>null</CarrierPrice>
    <CategoryPath>>> Phones >> Galaxies</CategoryPath>
    <ChannelName>English Channel</ChannelName>
    <Comments></Comments>
    <ContractNumber>12345</ContractNumber>
    <CustomerID>131149</CustomerID>
    <CustomerName>Bob Jones</CustomerName>
    <DateCreated>2016-05-13T12:18:08.723</DateCreated>
    <DistrictName>Westminster</DistrictName>
    <EmployeeName>iQmetrix User</EmployeeName>
    <GlobalProductID>5179</GlobalProductID>
    <InvoicedAt>100: My Network LLC - Anchorage</InvoicedAt>
    <InvoicedBy>100: My Network LLC - Anchorage</InvoicedBy>
    <InvoiceIDByStore>77224IN3</InvoiceIDByStore>
    <IsOrderServiceDropShipProduct>null</IsOrderServiceDropShipProduct>
    <IsOrderServiceShippingProduct>null</IsOrderServiceShippingProduct>
    <ListPrice>449.95</ListPrice>
    <OriginalUnitPrice>25</OriginalUnitPrice>
    <Priority>1</Priority>
    <ProductCouponDiscount>0</ProductCouponDiscount>
    <ProductIdentifier>ASHCSA000120</ProductIdentifier>
    <ProductName>Samsung Galaxy Rugby LTE</ProductName>
    <Quantity>1</Quantity>
    <Refund>0</Refund>
    <RegionName>London</RegionName>
    <RetailerCatalogID>null</RetailerCatalogID>
    <SaleInvoice_RowID>8c6537ae-75a5-4155-82b2-c8647ed05f3d</SaleInvoice_RowID>
    <SaleInvoiceID>128962</SaleInvoiceID>
    <SaleInvoiceProduct_RowID>0099b78f-ba02-4a91-afd4-2f7eb0fbbb06</SaleInvoiceProduct_RowID>
    <SerialNumber>1111111</SerialNumber>
    <SoldAsUsed>false</SoldAsUsed>
    <SpecialProductID>0</SpecialProductID>
    <StoreInStoreFlowIsEnabledForStore>false</StoreInStoreFlowIsEnabledForStore>
    <StoreInStoreGrossProfit>null</StoreInStoreGrossProfit>
    <StoreInStoreListPrice>null</StoreInStoreListPrice>
    <StoreInStorePrice>null</StoreInStorePrice>
    <StoreTypeName>Costco</StoreTypeName>
    <TenderedBy>iQmetrix User</TenderedBy>
    <TotalCost>0</TotalCost>
    <TotalDiscount>424.95</TotalDiscount>
    <TotalPrice>25</TotalPrice>
    <UnitCost>0</UnitCost>
    <UnitPrice>25</UnitPrice>
    <VendorName></VendorName>
    <VendorSKU></VendorSKU>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Activation_RowID,AdjustedUnitPrice,CarrierPrice,CategoryPath,ChannelName,Comments,ContractNumber,CustomerID,CustomerName,DateCreated,DistrictName,EmployeeName,GlobalProductID,InvoicedAt,InvoicedBy,InvoiceIDByStore,IsOrderServiceDropShipProduct,IsOrderServiceShippingProduct,ListPrice,OriginalUnitPrice,Priority,ProductCouponDiscount,ProductIdentifier,ProductName,Quantity,Refund,RegionName,RetailerCatalogID,SaleInvoice_RowID,SaleInvoiceID,SaleInvoiceProduct_RowID,SerialNumber,SoldAsUsed,SpecialProductID,StoreInStoreFlowIsEnabledForStore,StoreInStoreGrossProfit,StoreInStoreListPrice,StoreInStorePrice,StoreTypeName,TenderedBy,TotalCost,TotalDiscount,TotalPrice,UnitCost,UnitPrice,VendorName,VendorSKU
d3d65281-5201-4927-9bac-6f3a47ddf56b,25,null,>> Phones >> Galaxies,English Channel,,12345,131149,Bob Jones,2016-05-13T12:18:08.723,Westminster,iQmetrix User,5179,100: My Network LLC - Anchorage,100: My Network LLC - Anchorage,77224IN3,null,null,449.95,25,1,0,ASHCSA000120,Samsung Galaxy Rugby LTE,1,0,London,null,8c6537ae-75a5-4155-82b2-c8647ed05f3d,128962,0099b78f-ba02-4a91-afd4-2f7eb0fbbb06,1111111,false,0,false,null,null,null,Costco,iQmetrix User,0,424.95,25,0,25,,

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Token is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
HTTP 503 Maintenance The requested data is currently undergoing scheduled maintenance, please try again after 12:00PM UTC
Was this page helpful?