API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

ENDPOINTS

RESOURCES

GetActivePriceSheetPromotionsByStoreData

[
    {
        "PromotionID": 158,
        "PromotionName": "Free Gift Card",
        "StopDate": "2014-12-16T00:00:00",
        "OnlyNewActivations": 0
    }
]
Name Description
PromotionID (INT) Identifier for a promotion RQ
PromotionName (NVARCHAR(MAX)) Promotion name
StopDate (DateTime) Promotion end date, if this is empty the promotion is continual
OnlyNewActivations (INT) A flag to indicate if this promotion is for new activations only (1) or not (0)

GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStoreData

[
    {
        "PromotionID": 36,
        "HardwareProductLibraryID": "M512"
    }
]
Name Description
PromotionID (INT) Identifier for a promotion in RQ
HardwareProductLibraryID (VARCHAR(50)) Product slug

GetContractTermsForActivePriceSheetPromotionsByStoreData

[
    {
        "PromotionID": 36,
        "ContractTermName": "250 GB Free"
    }
]
Name Description
PromotionID (INT) Identifier for a promotion in RQ
ContractTermName (VARCHAR(50)) Contract term name

REQUESTS

GET Hardware Product Library IDs for Active Price Sheet Promotions By Store

Definition

GET /commerce/GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStore?CompanyID={CompanyID}&StoreID={StoreID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /commerce/GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingHardwareProductLibraryIdsForActivePriceSheetPromotionsByStore()
{
    var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=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 GettingHardwareProductLibraryIdsForActivePriceSheetPromotionsByStore() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GetHardwareProductLibraryIDsForActivePriceSheetPromotionsByStoreData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "PromotionID": 36,
        "HardwareProductLibraryID": "M512"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "PromotionID": 36,
            "HardwareProductLibraryID": "M512"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <PromotionID>36</PromotionID>
    <HardwareProductLibraryID>M512</HardwareProductLibraryID>
  </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
PromotionID,HardwareProductLibraryID
36,M512

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 Active Price Sheet Promotions By Store

Definition

GET /commerce/GetActivePriceSheetPromotionsByStore?CompanyID={CompanyID}&StoreID={StoreID}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /commerce/GetActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingActivePriceSheetPromotionsByStore()
{
    var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&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 GettingActivePriceSheetPromotionsByStore() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&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://rqdataconnectdemo.iqmetrix.net/private//commerce/GetActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GetActivePriceSheetPromotionsByStoreData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "PromotionID": 158,
        "PromotionName": "Free Gift Card",
        "StopDate": "2014-12-16T00:00:00",
        "OnlyNewActivations": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "PromotionID": 158,
            "PromotionName": "Free Gift Card",
            "StopDate": "2014-12-16T00:00:00",
            "OnlyNewActivations": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <PromotionID>158</PromotionID>
    <PromotionName>Free Gift Card</PromotionName>
    <StopDate>2014-12-16T00:00:00</StopDate>
    <OnlyNewActivations>0</OnlyNewActivations>
  </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
PromotionID,PromotionName,StopDate,OnlyNewActivations
158,Free Gift Card,2014-12-16T00:00:00,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 Contract Terms for Active Price Sheet Promotions By Store

Definition

GET /commerce/GetContractTermsForActivePriceSheetPromotionsByStore?CompanyID={CompanyID}&StoreID={StoreID}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /commerce/GetContractTermsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetContractTermsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingContractTermsForActivePriceSheetPromotionsByStore()
{
    var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetContractTermsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&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 GettingContractTermsForActivePriceSheetPromotionsByStore() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://rqdataconnectdemo.iqmetrix.net/private//commerce/GetContractTermsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&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://rqdataconnectdemo.iqmetrix.net/private//commerce/GetContractTermsForActivePriceSheetPromotionsByStore?CompanyID=22573&StoreID=1&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GetContractTermsForActivePriceSheetPromotionsByStoreData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "PromotionID": 36,
        "ContractTermName": "250 GB Free"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "PromotionID": 36,
            "ContractTermName": "250 GB Free"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <PromotionID>36</PromotionID>
    <ContractTermName>250 GB Free</ContractTermName>
  </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
PromotionID,ContractTermName
36,250 GB Free

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
Was this page helpful?