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

DailySalesSummaryReportData

[
    {
        "DateCreated": "2016-01-05T00:00:00",
        "QtySold": 19,
        "QtyRefunded": -7,
        "NetQty": 12,
        "TotalInvoiced": 266.38,
        "Adjustment": 0,
        "Net": 246.38,
        "Cost": 80.92,
        "Coupon": 0,
        "CouponTax": 0,
        "Profit": 165.46
    }
]
Name Description
DateCreated (DateTime) Created On - date the products were tendered or refunded
QtySold (INT) Qty Sold - total number of products sold
QtyRefunded (INT) Qty Ref - total number of products refunded
NetQty (INT) Net Qty - net total number of products
TotalInvoiced (MONEY) Total Invoiced - total dollar value of all invoiced products
Adjustment (MONEY) Adjustment - the net dollar amount of any adjustments for this day
Net (MONEY) Sales - total dollar value of all sales
Cost (MONEY) Cost - total purchase cost for all products sold that day
Coupon (MONEY) Coupon - dollar amount of coupons used on sale
CouponTax (MONEY) Coupon Taxes - dollar amount of coupon taxes on sale
Profit (MONEY) Gross Profit - gross profit, calculated as Sales - Cost

PerformanceMetrixReportData

[
    {
        "ID": 4,
        "Name": "Attachment Ratio",
        "Priority1": -1,
        "SearchDateQuantity": 0,
        "SearchDateSales": 0,
        "SearchDateProfit": 0,
        "SearchDateMargin": 0,
        "SearchDateAttachmentRate": "9 : 0",
        "Quantity": 0,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "QuantityPercentOfTarget": 0,
        "SalesPercentOfTarget": 0,
        "ProfitPercentOfTarget": 0,
        "MarginPercentOfTarget": 0,
        "QuantityTrending": 0,
        "SalesTrending": 0,
        "ProfitTrending": 0,
        "MarginTrending": 0,
        "QuantityTrendingPercentOfTarget": 0,
        "SalesTrendingPercentOfTarget": 0,
        "ProfitTrendingPercentOfTarget": 0,
        "MarginTrendingPercentOfTarget": 0,
        "QuantityTarget": 0,
        "SalesTarget": 0,
        "ProfitTarget": 0,
        "MarginTarget": 0,
        "AttachmentRateTarget": "0 : 0",
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]
Name Description
ID (INT) Internal identifier in RQ
Name (NVARCHAR(MAX)) Group - name of the group
Priority1 (INT) Internal value in RQ
SearchDateQuantity (MONEY) Quantity to Date - numeric and displays to nearest integer
SearchDateSales (MONEY) Sales to Date ($) - amount in dollars for sales to date
SearchDateProfit (MONEY) Profit to Date - numeric and displays to nearest integer
SearchDateMargin (DECIMAL) Margin to Date - numeric and displays to nearest integer
SearchDateAttachmentRate (VARCHAR(23)) Margin % of Target - percentage and displays Margin to date / target
Quantity (MONEY) Quantity Today - numeric and displays to nearest integer for today
Sales (MONEY) Today - numeric and displays to nearest integer for today
Profit (MONEY) Profit Today - numeric and displays to nearest integer for today
Margin (DECIMAL) Margin Today - numeric and displays to nearest integer for today
QuantityPercentOfTarget (DECIMAL) Quantity % of Target - percentage and displays Quantity to date / target
SalesPercentOfTarget (DECIMAL) Sales % of Target - percentage and displays sales to date / target
ProfitPercentOfTarget (DECIMAL) Profit % of Target - percentage and displays Profit to date / target
MarginPercentOfTarget (DECIMAL) Margin % of Target - percentage and displays Margin to date / target
QuantityTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Quantity To Date / (Date - beginning of period + 1)) * # of days in the period.
SalesTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Sales To Date / (Date - beginning of period + 1)) * # of days in the period.
ProfitTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Profit To Date / (Date - beginning of period + 1)) * # of days in the period.
MarginTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Margin To Date / (Date - beginning of period + 1)) * # of days in the period.
QuantityTrendingPercentOfTarget (DECIMAL) Quantity % of Target - percentage and displays Quantity to date / target
SalesTrendingPercentOfTarget (DECIMAL) Trending % of Target - percentage and displays trending / target
ProfitTrendingPercentOfTarget (DECIMAL) Trending % of Target - percentage and displays trending / target
MarginTrendingPercentOfTarget (DECIMAL) Trending % of Target - percentage and displays trending / target
QuantityTarget (INT) Target - numeric and displays the target set in the Performance Targets Setup
SalesTarget (MONEY) Target - numeric and displays the target set in the Performance Targets Setup
ProfitTarget (MONEY) Target - numeric and displays the target set in the Performance Targets Setup
MarginTarget (DECIMAL) Target - numeric and displays the target set in the Performance Targets Setup
AttachmentRateTarget (VARCHAR(23)) Target - numeric and displays the target set in the Performance Targets Setup
IsAttachmentRate (BIT) Internal value in RQ
DisplayFormat (INT) Internal value in RQ
AttachmentRate (VARCHAR(23)) Rate - as calculated by the AR (PG1 divided by PG2)

PerformanceMetrixSummaryReportData

[
    {
        "GroupID": 5,
        "GroupName": "Accessories & Devices",
        "Priority": -1,
        "Quantity": 1,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "Enabled": 1,
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]
Name Description
GroupID (INT) Internal identifier in RQ
GroupName (NVARCHAR(MAX)) Group Name - name of the performance group
Priority (INT) Internal value in RQ
Quantity (INT) Quantity - net count of SKUs sold in this group for the search criteria
Sales (MONEY) Sales - net dollar amount of sales in this group for the search criteria
Profit (MONEY) Profit - net profit amount of sales in this group for the search criteria
Margin (DECIMAL) Margin - margin on the sales in this group for the search criteria
Enabled (INT) Internal value in RQ
IsAttachmentRate (BIT) Internal value in RQ
DisplayFormat (INT) Internal value in RQ
AttachmentRate (VARCHAR(23)) Rate - as calculated by the AR (PG1 divided by PG2)

ProductSummaryReportData

[
    {
        "ProductIdentifier": "AAATAP000094",
        "SpecialProductID": 0,
        "ProductName": "Apple iPhone 6 Plus 16GB White - AT&T",
        "TotalInvoiced": 949.98,
        "Adjustment": 0,
        "ExtendedUnitPrice": 949.98,
        "ExtendedUnitCost": 0,
        "ExtendedUnitProfit": 949.98,
        "PercentProfit": 100,
        "QuantitySold": 2,
        "QuantityRefunded": 0,
        "NetQuantity": 2,
        "ManufacturerPartNumber": "1234567890-pl",
        "VendorPartNumber": "10999",
        "BarCode": "738516343990"
    }
]
Name Description
ProductIdentifier (VARCHAR(12)) Product SKU - RQ generated SKU
SpecialProductID (INT) Acceptable values include 0 for Regular Product, 1 for Vendor Rebate, 2 for Non-Stocked Product, 3 for Gift Card, 4 for Non Revenue Product
ProductName (NVARCHAR(MAX)) Product Name - name of the product as it appears in the inventory
TotalInvoiced (MONEY) Total Invoiced - net dollar amount of this product SKU invoiced
Adjustment (MONEY) Adjustment - net dollar amount of any adjustments for this product SKU
ExtendedUnitPrice (MONEY) Avg Sales Price - calculates as Total Sales / Net Quantity
ExtendedUnitCost (MONEY) Cost - purchase cost of the product SKU
ExtendedUnitProfit (MONEY) Gross Profit - profit calculated as Sales - Cost
PercentProfit (MONEY) % Profit - profit expressed as a percentage
QuantitySold (INT) Qty Sold - total quantity of the product SKU sold before refunds
QuantityRefunded (INT) Qty Ref - total quantity of the product SKU refunded
NetQuantity (INT) Net Qty - net quantity sold, calculated as Qty Sold minus Qty Refunded
ManufacturerPartNumber (VARCHAR(50)) Manufacturer SKU - SKU assigned by the manufacturer
VendorPartNumber (VARCHAR(25)) Vendor SKU - SKU assigned by the vendor
BarCode (NVARCHAR(MAX)) Bar Code - any bar code(s) you have assigned to this product

SalesByEmployeeReportData

[
    {
        "EmployeeID": 256,
        "EmployeeName": "iQmetrix Employee",
        "EmployeeSpecialIdentifier": "912345987654321",
        "StoreInStoreFlowIsEnabledForAtLeastOneStore": 0,
        "QtySold": 50,
        "QtyRefunded": 0,
        "NetQty": 50,
        "TotalInvoiced": 1825.74,
        "Adjustment": 0,
        "TotalSales": 1825.74,
        "TotalStoreInStoreSales": 0,
        "RoundingVariance": 0.26,
        "TotalCost": 284.33,
        "TotalCoupon": 5,
        "TotalCouponTax": 0,
        "TotalProfit": 1536.41,
        "TotalStoreInStoreProfit": 0,
        "TotalCommission": 0,
        "EmployeeUsername": "iQmetrix.Employee"
    }
]
Name Description
EmployeeID (INT) ID # - Employee ID number (assigned when hired; this is usually from a Payroll system)
EmployeeName (VARCHAR(51)) Employee - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box on the Accept Payment screen
EmployeeSpecialIdentifier (VARCHAR(25)) Internal identifier in RQ
StoreInStoreFlowIsEnabledForAtLeastOneStore (INT) A flag to indicate if Store in Store Flow is enabled for at least one store (1) or not (0)
QtySold (BIGINT) Qty Sold - total number of products sold
QtyRefunded (BIGINT) Qty Ref - total number of products refunded
NetQty (INT) Net Qty - net total number of products
TotalInvoiced (MONEY) Total Invoiced - total dollar value of all invoiced products
Adjustment (MONEY) Adjustment - the net dollar amount of any adjustments for this day
TotalSales (MONEY) Sales - total dollar value of all sales
TotalStoreInStoreSales (MONEY) Total store in store sales
RoundingVariance (MONEY) Rounding Variance - total dollar value of the rounding variance [may not appear in your database]
TotalCost (MONEY) Cost - total purchase cost for all products sold that day
TotalCoupon (MONEY) Coupon - value of any coupons. The Coupon column will only appear when the user runs the report with All Categories or does not select any product in the product picker when running by This Product.
TotalCouponTax (MONEY) Coupon Taxes - the value for any taxed coupons
TotalProfit (MONEY) Gross Profit - gross profit, calculated as Sales - Cost
TotalStoreInStoreProfit (MONEY) Total store in store profit
TotalCommission (MONEY) Commission - total dollar amount of commission calculated for the employee
EmployeeUsername (VARCHAR(51)) Username - username of the employee of record for the sale, i.e. the employee whose name is in the Commission box on the Accept Payment screen

SalesByLocationReportData

[
    {
        "StoreID": 1,
        "StoreTypeName": "Retail Store",
        "StoreName": "84 West",
        "Date": 1,
        "DateName": "2016-01-01T00:00:00",
        "StoreInStoreFlowIsEnabledForStore": false,
        "QtySold": 283,
        "QtyRefunded": -23,
        "NetQty": 260,
        "TotalInvoiced": 17738.1,
        "Adjustment": 0,
        "Net": 16293.58,
        "StoreInStoreNet": 0,
        "Cost": 90004818.51,
        "Coupon": 77.48,
        "CouponTax": 1,
        "Profit": -89988524.93,
        "StoreInStoreGrossProfit": 0,
        "RegionName": "Region A",
        "DistrictName": "Valley Area District",
        "ChannelName": "Regina Channel",
        "RoundingVariance": 0.6
    }
]
Name Description
StoreID (INT) Identifier for a store in RQ
StoreTypeName (NVARCHAR(MAX)) Location Type - location type the the transaction was performed at
StoreName (NVARCHAR(MAX)) Location - name of the location being displayed
Date (INT) Date
DateName (DateTime) Date value
StoreInStoreFlowIsEnabledForStore (BIT) A flag to indicate if SIS is enabled
QtySold (INT) Qty Sold - total number of products, as selected in search criteria, sold
QtyRefunded (INT) Qty Ref - total number of products, as selected in search criteria, refunded
NetQty (INT) Net Qty - total net quantity of products, as selected in search criteria, sold
TotalInvoiced (MONEY) Total Invoiced - net dollar amount invoiced in the search criteria
Adjustment (MONEY) Adjustment - net dollar amount of any Vendor Rebate Product (VRP)
Net (MONEY) Sales - total dollar value of all products in the search criteria after adjustments are applied
StoreInStoreNet (MONEY) Store in store net
Cost (MONEY) Cost - purchase cost of all products in the search criteria
Coupon (MONEY) Coupon - dollar amount of coupons used
CouponTax (MONEY) Coupon Taxes - amount in dollars of coupon taxes on sales
Profit (MONEY) Gross Profit - profit, calculated as Sales - Cost
StoreInStoreGrossProfit (MONEY) Store in store profit
RegionName (NVARCHAR(MAX)) Region - region for the rows location
DistrictName (NVARCHAR(MAX)) District - district for the rows location
ChannelName (NVARCHAR(MAX)) Channel - channel for the rows location
RoundingVariance (MONEY) Rounding Variance - Canadian clients dealing with the deletion of the penny, see Penny Rounding for more detail

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

GET the Daily Sales Summary Report

For more information, see Daily Sales Summary Report.

Definition

GET /private/visions/DailySalesSummaryReport?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&CategoryNumber={CategoryNumber}&SpecialProductID={SpecialProductID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}ProductIdentifier={ProductIdentifier}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /private/visions/DailySalesSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&SpecialProductID=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2ProductIdentifier=ASCLMO000001&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private/visions/DailySalesSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&SpecialProductID=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2ProductIdentifier=ASCLMO000001&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheDailySalesSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private/visions/DailySalesSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&SpecialProductID=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2ProductIdentifier=ASCLMO000001&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 GettingTheDailySalesSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private/visions/DailySalesSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&SpecialProductID=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2ProductIdentifier=ASCLMO000001&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/private/visions/DailySalesSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&SpecialProductID=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2ProductIdentifier=ASCLMO000001&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[DailySalesSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "DateCreated": "2016-01-05T00:00:00",
        "QtySold": 19,
        "QtyRefunded": -7,
        "NetQty": 12,
        "TotalInvoiced": 266.38,
        "Adjustment": 0,
        "Net": 246.38,
        "Cost": 80.92,
        "Coupon": 0,
        "CouponTax": 0,
        "Profit": 165.46
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "DateCreated": "2016-01-05T00:00:00",
            "QtySold": 19,
            "QtyRefunded": -7,
            "NetQty": 12,
            "TotalInvoiced": 266.38,
            "Adjustment": 0,
            "Net": 246.38,
            "Cost": 80.92,
            "Coupon": 0,
            "CouponTax": 0,
            "Profit": 165.46
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DateCreated>2016-01-05T00:00:00</DateCreated>
    <QtySold>19</QtySold>
    <QtyRefunded>-7</QtyRefunded>
    <NetQty>12</NetQty>
    <TotalInvoiced>266.38</TotalInvoiced>
    <Adjustment>0</Adjustment>
    <Net>246.38</Net>
    <Cost>80.92</Cost>
    <Coupon>0</Coupon>
    <CouponTax>0</CouponTax>
    <Profit>165.46</Profit>
  </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
DateCreated,QtySold,QtyRefunded,NetQty,TotalInvoiced,Adjustment,Net,Cost,Coupon,CouponTax,Profit
2016-01-05T00:00:00,19,-7,12,266.38,0,246.38,80.92,0,0,165.46

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 Performance Metrix Report

For more information see Performance Metrix Report.

Definition

GET /private/visions/PerformanceMetrixReport?CompanyID={CompanyID}&DateAsOf={DateAsOf}&HideRebates={HideRebates}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /private/visions/PerformanceMetrixReport?CompanyID=21090&DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private/visions/PerformanceMetrixReport?CompanyID=21090&DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingThePerformanceMetrixReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private/visions/PerformanceMetrixReport?CompanyID=21090&DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&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 GettingThePerformanceMetrixReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private/visions/PerformanceMetrixReport?CompanyID=21090&DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&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/private/visions/PerformanceMetrixReport?CompanyID=21090&DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PerformanceMetrixReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 4,
        "Name": "Attachment Ratio",
        "Priority1": -1,
        "SearchDateQuantity": 0,
        "SearchDateSales": 0,
        "SearchDateProfit": 0,
        "SearchDateMargin": 0,
        "SearchDateAttachmentRate": "9 : 0",
        "Quantity": 0,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "QuantityPercentOfTarget": 0,
        "SalesPercentOfTarget": 0,
        "ProfitPercentOfTarget": 0,
        "MarginPercentOfTarget": 0,
        "QuantityTrending": 0,
        "SalesTrending": 0,
        "ProfitTrending": 0,
        "MarginTrending": 0,
        "QuantityTrendingPercentOfTarget": 0,
        "SalesTrendingPercentOfTarget": 0,
        "ProfitTrendingPercentOfTarget": 0,
        "MarginTrendingPercentOfTarget": 0,
        "QuantityTarget": 0,
        "SalesTarget": 0,
        "ProfitTarget": 0,
        "MarginTarget": 0,
        "AttachmentRateTarget": "0 : 0",
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 4,
            "Name": "Attachment Ratio",
            "Priority1": -1,
            "SearchDateQuantity": 0,
            "SearchDateSales": 0,
            "SearchDateProfit": 0,
            "SearchDateMargin": 0,
            "SearchDateAttachmentRate": "9 : 0",
            "Quantity": 0,
            "Sales": 0,
            "Profit": 0,
            "Margin": 0,
            "QuantityPercentOfTarget": 0,
            "SalesPercentOfTarget": 0,
            "ProfitPercentOfTarget": 0,
            "MarginPercentOfTarget": 0,
            "QuantityTrending": 0,
            "SalesTrending": 0,
            "ProfitTrending": 0,
            "MarginTrending": 0,
            "QuantityTrendingPercentOfTarget": 0,
            "SalesTrendingPercentOfTarget": 0,
            "ProfitTrendingPercentOfTarget": 0,
            "MarginTrendingPercentOfTarget": 0,
            "QuantityTarget": 0,
            "SalesTarget": 0,
            "ProfitTarget": 0,
            "MarginTarget": 0,
            "AttachmentRateTarget": "0 : 0",
            "IsAttachmentRate": true,
            "DisplayFormat": 2,
            "AttachmentRate": "114 : 0"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>4</ID>
    <Name>Attachment Ratio</Name>
    <Priority1>-1</Priority1>
    <SearchDateQuantity>0</SearchDateQuantity>
    <SearchDateSales>0</SearchDateSales>
    <SearchDateProfit>0</SearchDateProfit>
    <SearchDateMargin>0</SearchDateMargin>
    <SearchDateAttachmentRate>9 : 0</SearchDateAttachmentRate>
    <Quantity>0</Quantity>
    <Sales>0</Sales>
    <Profit>0</Profit>
    <Margin>0</Margin>
    <QuantityPercentOfTarget>0</QuantityPercentOfTarget>
    <SalesPercentOfTarget>0</SalesPercentOfTarget>
    <ProfitPercentOfTarget>0</ProfitPercentOfTarget>
    <MarginPercentOfTarget>0</MarginPercentOfTarget>
    <QuantityTrending>0</QuantityTrending>
    <SalesTrending>0</SalesTrending>
    <ProfitTrending>0</ProfitTrending>
    <MarginTrending>0</MarginTrending>
    <QuantityTrendingPercentOfTarget>0</QuantityTrendingPercentOfTarget>
    <SalesTrendingPercentOfTarget>0</SalesTrendingPercentOfTarget>
    <ProfitTrendingPercentOfTarget>0</ProfitTrendingPercentOfTarget>
    <MarginTrendingPercentOfTarget>0</MarginTrendingPercentOfTarget>
    <QuantityTarget>0</QuantityTarget>
    <SalesTarget>0</SalesTarget>
    <ProfitTarget>0</ProfitTarget>
    <MarginTarget>0</MarginTarget>
    <AttachmentRateTarget>0 : 0</AttachmentRateTarget>
    <IsAttachmentRate>true</IsAttachmentRate>
    <DisplayFormat>2</DisplayFormat>
    <AttachmentRate>114 : 0</AttachmentRate>
  </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
ID,Name,Priority1,SearchDateQuantity,SearchDateSales,SearchDateProfit,SearchDateMargin,SearchDateAttachmentRate,Quantity,Sales,Profit,Margin,QuantityPercentOfTarget,SalesPercentOfTarget,ProfitPercentOfTarget,MarginPercentOfTarget,QuantityTrending,SalesTrending,ProfitTrending,MarginTrending,QuantityTrendingPercentOfTarget,SalesTrendingPercentOfTarget,ProfitTrendingPercentOfTarget,MarginTrendingPercentOfTarget,QuantityTarget,SalesTarget,ProfitTarget,MarginTarget,AttachmentRateTarget,IsAttachmentRate,DisplayFormat,AttachmentRate
4,Attachment Ratio,-1,0,0,0,0,9 : 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 : 0,true,2,114 : 0

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 Performance Metrix Summary Report

For more information see Performance Metrix Summary Report.

Definition

GET /private/visions/PerformanceMetrixSummaryReport?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&ReportType={ReportType}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /private/visions/PerformanceMetrixSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private/visions/PerformanceMetrixSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingThePerformanceMetrixSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private/visions/PerformanceMetrixSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&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 GettingThePerformanceMetrixSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private/visions/PerformanceMetrixSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&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/private/visions/PerformanceMetrixSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PerformanceMetrixSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GroupID": 5,
        "GroupName": "Accessories & Devices",
        "Priority": -1,
        "Quantity": 1,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "Enabled": 1,
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GroupID": 5,
            "GroupName": "Accessories & Devices",
            "Priority": -1,
            "Quantity": 1,
            "Sales": 0,
            "Profit": 0,
            "Margin": 0,
            "Enabled": 1,
            "IsAttachmentRate": true,
            "DisplayFormat": 2,
            "AttachmentRate": "114 : 0"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GroupID>5</GroupID>
    <GroupName>Accessories & Devices</GroupName>
    <Priority>-1</Priority>
    <Quantity>1</Quantity>
    <Sales>0</Sales>
    <Profit>0</Profit>
    <Margin>0</Margin>
    <Enabled>1</Enabled>
    <IsAttachmentRate>true</IsAttachmentRate>
    <DisplayFormat>2</DisplayFormat>
    <AttachmentRate>114 : 0</AttachmentRate>
  </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
GroupID,GroupName,Priority,Quantity,Sales,Profit,Margin,Enabled,IsAttachmentRate,DisplayFormat,AttachmentRate
5,Accessories & Devices,-1,1,0,0,0,1,true,2,114 : 0

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 Summary Report

For more information, see Product Summary Report.

Definition

GET /private/visions/ProductSummaryReport?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&CategoryNumber={CategoryNumber}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /private/visions/ProductSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private/visions/ProductSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheProductSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private/visions/ProductSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&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 GettingTheProductSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private/visions/ProductSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&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/private/visions/ProductSummaryReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CategoryNumber=10&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ProductSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ProductIdentifier": "AAATAP000094",
        "SpecialProductID": 0,
        "ProductName": "Apple iPhone 6 Plus 16GB White - AT&T",
        "TotalInvoiced": 949.98,
        "Adjustment": 0,
        "ExtendedUnitPrice": 949.98,
        "ExtendedUnitCost": 0,
        "ExtendedUnitProfit": 949.98,
        "PercentProfit": 100,
        "QuantitySold": 2,
        "QuantityRefunded": 0,
        "NetQuantity": 2,
        "ManufacturerPartNumber": "1234567890-pl",
        "VendorPartNumber": "10999",
        "BarCode": "738516343990"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ProductIdentifier": "AAATAP000094",
            "SpecialProductID": 0,
            "ProductName": "Apple iPhone 6 Plus 16GB White - AT&T",
            "TotalInvoiced": 949.98,
            "Adjustment": 0,
            "ExtendedUnitPrice": 949.98,
            "ExtendedUnitCost": 0,
            "ExtendedUnitProfit": 949.98,
            "PercentProfit": 100,
            "QuantitySold": 2,
            "QuantityRefunded": 0,
            "NetQuantity": 2,
            "ManufacturerPartNumber": "1234567890-pl",
            "VendorPartNumber": "10999",
            "BarCode": "738516343990"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ProductIdentifier>AAATAP000094</ProductIdentifier>
    <SpecialProductID>0</SpecialProductID>
    <ProductName>Apple iPhone 6 Plus 16GB White - AT&T</ProductName>
    <TotalInvoiced>949.98</TotalInvoiced>
    <Adjustment>0</Adjustment>
    <ExtendedUnitPrice>949.98</ExtendedUnitPrice>
    <ExtendedUnitCost>0</ExtendedUnitCost>
    <ExtendedUnitProfit>949.98</ExtendedUnitProfit>
    <PercentProfit>100</PercentProfit>
    <QuantitySold>2</QuantitySold>
    <QuantityRefunded>0</QuantityRefunded>
    <NetQuantity>2</NetQuantity>
    <ManufacturerPartNumber>1234567890-pl</ManufacturerPartNumber>
    <VendorPartNumber>10999</VendorPartNumber>
    <BarCode>738516343990</BarCode>
  </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
ProductIdentifier,SpecialProductID,ProductName,TotalInvoiced,Adjustment,ExtendedUnitPrice,ExtendedUnitCost,ExtendedUnitProfit,PercentProfit,QuantitySold,QuantityRefunded,NetQuantity,ManufacturerPartNumber,VendorPartNumber,BarCode
AAATAP000094,0,Apple iPhone 6 Plus 16GB White - AT&T,949.98,0,949.98,0,949.98,100,2,0,2,1234567890-pl,10999,738516343990

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 Sales by Employee Report

For more information, see Sales by Employee Report.

Definition

GET /private/visions/SalesByEmployeeReport?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&CategoryNumber={CategoryNumber}&ProductIdentifier={ProductIdentifier}&AssignedGroupID={AssignedGroupID}&CommissionGroupID={CommissionGroupID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /private/visions/SalesByEmployeeReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&AssignedGroupID=2&CommissionGroupID=2
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private/visions/SalesByEmployeeReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&AssignedGroupID=2&CommissionGroupID=2" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheSalesByEmployeeReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private/visions/SalesByEmployeeReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&AssignedGroupID=2&CommissionGroupID=2");
    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 GettingTheSalesByEmployeeReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private/visions/SalesByEmployeeReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&AssignedGroupID=2&CommissionGroupID=2");
     
    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/private/visions/SalesByEmployeeReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&AssignedGroupID=2&CommissionGroupID=2', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SalesByEmployeeReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeID": 256,
        "EmployeeName": "iQmetrix Employee",
        "EmployeeSpecialIdentifier": "912345987654321",
        "StoreInStoreFlowIsEnabledForAtLeastOneStore": 0,
        "QtySold": 50,
        "QtyRefunded": 0,
        "NetQty": 50,
        "TotalInvoiced": 1825.74,
        "Adjustment": 0,
        "TotalSales": 1825.74,
        "TotalStoreInStoreSales": 0,
        "RoundingVariance": 0.26,
        "TotalCost": 284.33,
        "TotalCoupon": 5,
        "TotalCouponTax": 0,
        "TotalProfit": 1536.41,
        "TotalStoreInStoreProfit": 0,
        "TotalCommission": 0,
        "EmployeeUsername": "iQmetrix.Employee"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeID": 256,
            "EmployeeName": "iQmetrix Employee",
            "EmployeeSpecialIdentifier": "912345987654321",
            "StoreInStoreFlowIsEnabledForAtLeastOneStore": 0,
            "QtySold": 50,
            "QtyRefunded": 0,
            "NetQty": 50,
            "TotalInvoiced": 1825.74,
            "Adjustment": 0,
            "TotalSales": 1825.74,
            "TotalStoreInStoreSales": 0,
            "RoundingVariance": 0.26,
            "TotalCost": 284.33,
            "TotalCoupon": 5,
            "TotalCouponTax": 0,
            "TotalProfit": 1536.41,
            "TotalStoreInStoreProfit": 0,
            "TotalCommission": 0,
            "EmployeeUsername": "iQmetrix.Employee"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeID>256</EmployeeID>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeSpecialIdentifier>912345987654321</EmployeeSpecialIdentifier>
    <StoreInStoreFlowIsEnabledForAtLeastOneStore>0</StoreInStoreFlowIsEnabledForAtLeastOneStore>
    <QtySold>50</QtySold>
    <QtyRefunded>0</QtyRefunded>
    <NetQty>50</NetQty>
    <TotalInvoiced>1825.74</TotalInvoiced>
    <Adjustment>0</Adjustment>
    <TotalSales>1825.74</TotalSales>
    <TotalStoreInStoreSales>0</TotalStoreInStoreSales>
    <RoundingVariance>0.26</RoundingVariance>
    <TotalCost>284.33</TotalCost>
    <TotalCoupon>5</TotalCoupon>
    <TotalCouponTax>0</TotalCouponTax>
    <TotalProfit>1536.41</TotalProfit>
    <TotalStoreInStoreProfit>0</TotalStoreInStoreProfit>
    <TotalCommission>0</TotalCommission>
    <EmployeeUsername>iQmetrix.Employee</EmployeeUsername>
  </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
EmployeeID,EmployeeName,EmployeeSpecialIdentifier,StoreInStoreFlowIsEnabledForAtLeastOneStore,QtySold,QtyRefunded,NetQty,TotalInvoiced,Adjustment,TotalSales,TotalStoreInStoreSales,RoundingVariance,TotalCost,TotalCoupon,TotalCouponTax,TotalProfit,TotalStoreInStoreProfit,TotalCommission,EmployeeUsername
256,iQmetrix Employee,912345987654321,0,50,0,50,1825.74,0,1825.74,0,0.26,284.33,5,0,1536.41,0,0,iQmetrix.Employee

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 Sales By Location Report

For more information, see Sales By Location Report.

Definition

GET /private/visions/SalesByLocationReport?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&CategoryNumber={CategoryNumber}&ProductIdentifier={ProductIdentifier}&StoreTypeID={StoreTypeID}&ByDate={ByMonth}&CouponIDs={CouponIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /private/visions/SalesByLocationReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&StoreTypeID=-1&ByDate=ByMonth&CouponIDs=-1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private/visions/SalesByLocationReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&StoreTypeID=-1&ByDate=ByMonth&CouponIDs=-1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheSalesByLocationReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private/visions/SalesByLocationReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&StoreTypeID=-1&ByDate=ByMonth&CouponIDs=-1");
    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 GettingTheSalesByLocationReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private/visions/SalesByLocationReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&StoreTypeID=-1&ByDate=ByMonth&CouponIDs=-1");
     
    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/private/visions/SalesByLocationReport?CompanyID=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001&StoreTypeID=-1&ByDate=ByMonth&CouponIDs=-1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SalesByLocationReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "StoreID": 1,
        "StoreTypeName": "Retail Store",
        "StoreName": "84 West",
        "Date": 1,
        "DateName": "2016-01-01T00:00:00",
        "StoreInStoreFlowIsEnabledForStore": false,
        "QtySold": 283,
        "QtyRefunded": -23,
        "NetQty": 260,
        "TotalInvoiced": 17738.1,
        "Adjustment": 0,
        "Net": 16293.58,
        "StoreInStoreNet": 0,
        "Cost": 90004818.51,
        "Coupon": 77.48,
        "CouponTax": 1,
        "Profit": -89988524.93,
        "StoreInStoreGrossProfit": 0,
        "RegionName": "Region A",
        "DistrictName": "Valley Area District",
        "ChannelName": "Regina Channel",
        "RoundingVariance": 0.6
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "StoreID": 1,
            "StoreTypeName": "Retail Store",
            "StoreName": "84 West",
            "Date": 1,
            "DateName": "2016-01-01T00:00:00",
            "StoreInStoreFlowIsEnabledForStore": false,
            "QtySold": 283,
            "QtyRefunded": -23,
            "NetQty": 260,
            "TotalInvoiced": 17738.1,
            "Adjustment": 0,
            "Net": 16293.58,
            "StoreInStoreNet": 0,
            "Cost": 90004818.51,
            "Coupon": 77.48,
            "CouponTax": 1,
            "Profit": -89988524.93,
            "StoreInStoreGrossProfit": 0,
            "RegionName": "Region A",
            "DistrictName": "Valley Area District",
            "ChannelName": "Regina Channel",
            "RoundingVariance": 0.6
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <StoreID>1</StoreID>
    <StoreTypeName>Retail Store</StoreTypeName>
    <StoreName>84 West</StoreName>
    <Date>1</Date>
    <DateName>2016-01-01T00:00:00</DateName>
    <StoreInStoreFlowIsEnabledForStore>false</StoreInStoreFlowIsEnabledForStore>
    <QtySold>283</QtySold>
    <QtyRefunded>-23</QtyRefunded>
    <NetQty>260</NetQty>
    <TotalInvoiced>17738.1</TotalInvoiced>
    <Adjustment>0</Adjustment>
    <Net>16293.58</Net>
    <StoreInStoreNet>0</StoreInStoreNet>
    <Cost>90004818.51</Cost>
    <Coupon>77.48</Coupon>
    <CouponTax>1</CouponTax>
    <Profit>-89988524.93</Profit>
    <StoreInStoreGrossProfit>0</StoreInStoreGrossProfit>
    <RegionName>Region A</RegionName>
    <DistrictName>Valley Area District</DistrictName>
    <ChannelName>Regina Channel</ChannelName>
    <RoundingVariance>0.6</RoundingVariance>
  </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
StoreID,StoreTypeName,StoreName,Date,DateName,StoreInStoreFlowIsEnabledForStore,QtySold,QtyRefunded,NetQty,TotalInvoiced,Adjustment,Net,StoreInStoreNet,Cost,Coupon,CouponTax,Profit,StoreInStoreGrossProfit,RegionName,DistrictName,ChannelName,RoundingVariance
1,Retail Store,84 West,1,2016-01-01T00:00:00,false,283,-23,260,17738.1,0,16293.58,0,90004818.51,77.48,1,-89988524.93,0,Region A,Valley Area District,Regina Channel,0.6

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?