API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve data from your RQ database (v4.23 and up).

To get started, see Data Connect Guide.

Note

For requests 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

Data Connect supports many different methods of authentication, see Authentication Options.

Note that for all reports the Access Token should be mapped to an employee in RQ.

Report List

For a complete list of reports in Data Connect, see Report List.

ENDPOINTS

RESOURCES

PurchaseOrder

[
    {
        "PurchaseOrderID": 17388,
        "PurchaseOrderIdByStore": "84WEAPO1061",
        "ReceivingID": -1,
        "DateCommitted": "",
        "ReceiverStoreID": 1,
        "ReceiverStore": "84 West",
        "OrdererStoreID": 1,
        "OrdererStore": "84 West",
        "EstimatedArrivalDate": "2015-07-06T00:00:00",
        "POCommitted": false,
        "POCompleted": false,
        "RowTimeStamp": "AAAAAAAtOeI=",
        "CreatedBy": "iQmetrix Employee",
        "VendorName": "Offwire",
        "ReferenceNumber": "",
        "DaysOnOrder": 0,
        "ModifiedBy": ""
    }
]
Name Description
PurchaseOrderID (INT) Internal identifier for a Purchase Order in RQ
PurchaseOrderIdByStore (VARCHAR(14)) Purchase Order # - Number assigned to the PO by RQ
ReceivingID (INT) Internal identifier in RQ
DateCommitted (DateTime) Committed On - Date and time committed
ReceiverStoreID (INT) Internal identifier for a store in RQ
ReceiverStore (NVARCHAR(MAX)) Receive At - Location the PO is to be received at
OrdererStoreID (INT) Internal identifier for a store in RQ
OrdererStore (NVARCHAR(MAX)) Ordered At - Location that ordered the PO
EstimatedArrivalDate (DateTime) ETA - Estimated time of arrival
POCommitted (BIT) A flag to indicate of the PO is committed
POCompleted (BIT) A flag to indicate if the PO is completed
RowTimeStamp (TIMESTAMP) Internal value in RQ
CreatedBy (VARCHAR(51)) Created By - Name of the logged in user when the PO was created
VendorName (NVARCHAR(MAX)) Vendor - Vendor who will fulfill the PO
ReferenceNumber (VARCHAR(50)) Reference # - Number assigned to the PO when it was committed
DaysOnOrder (INT) Days On Order - Number of days the PO has been on order
ModifiedBy (DateTime) Edited - Date and time the PO was edited

Transfer

[
    {
        "TransferID": 4193,
        "TransferIDByStore": "84WEATR328",
        "DateCommitted": "2015-05-27T08:23:29.59",
        "TransferCompleted": false,
        "Employee_Name": "iQmetrix Employee",
        "StoreFrom": "72 Cornwall",
        "StoreTo": "84 West",
        "DateRequested": "2015-05-27T08:23:29.59",
        "EstimatedArrivalDate": "2015-06-03T00:00:00",
        "TransferCommitted": true,
        "DaysInTransit": 0,
        "Shipped": "No"
    }
]
Name Description
TransferID (INT) Internal identifier for a transfer in RQ
TransferIDByStore (VARCHAR(14)) Transfer # - Number assigned to the transfer by RQ
DateCommitted (DateTime) Committed On - Date and time committed
TransferCompleted (BIT) A flag to indicate if the transfer is completed
Employee_Name (VARCHAR(51)) Employee name
StoreFrom (NVARCHAR(MAX)) Name of the store the transfer originatd from
StoreTo (NVARCHAR(MAX)) Name of the store the transfer was sent to
DateRequested (DateTime) Request On - Date transfer was requested
EstimatedArrivalDate (DateTime) ETA - Estimated time of arrival
TransferCommitted (BIT) A flag to indicate if the transfer is committed
DaysInTransit (INT) Number of days the Transfer spent in transit
Shipped (VARCHAR(3)) A flag to indicate if the transfer was shipped

RMA

[
    {
        "StockBalanceID": 1147,
        "VendorName": "Offwire",
        "RMANumber": "1234",
        "DateCreated": "2015-07-22T15:16:16.007",
        "ShippedAway": false,
        "CreatedBy": "iQmetrix Employee",
        "StoreName": "84 West",
        "StockBalanceCommitted": true
    }
]
Name Description
StockBalanceID (INT) Internal identifier for a RMA in RQ
VendorName (NVARCHAR(MAX)) Vendor
RMANumber (VARCHAR(15)) RMA # - Number assigned to the RMA by RQ
DateCreated (DateTime) Creaed date
ShippedAway (BIT) A flag to indicate if the RMA was shipped
CreatedBy (VARCHAR(51)) Name of employee who created RMA
StoreName (NVARCHAR(MAX)) Name of a store in RQ
StockBalanceCommitted (BIT) A flag to indicate if the RMA is committed

REQUESTS

GET Purchase Orders in RQ

For more information see Purchase Orders.

Definition

GET /inventory/PurchaseOrders?AlsoSearchByESN={AlsoSearchByESN}&Committed={Committed}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&VendorID={VendorID}&SearchTerm={SearchTerm}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /inventory/PurchaseOrders?AlsoSearchByESN=false&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&VendorID=-1&SearchTerm=84WEAPO1061&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/inventory/PurchaseOrders?AlsoSearchByESN=false&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&VendorID=-1&SearchTerm=84WEAPO1061&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPurchaseOrdersInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/inventory/PurchaseOrders?AlsoSearchByESN=false&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&VendorID=-1&SearchTerm=84WEAPO1061&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 GettingPurchaseOrdersInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/inventory/PurchaseOrders?AlsoSearchByESN=false&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&VendorID=-1&SearchTerm=84WEAPO1061&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/inventory/PurchaseOrders?AlsoSearchByESN=false&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&VendorID=-1&SearchTerm=84WEAPO1061&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PurchaseOrder]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "PurchaseOrderID": 17388,
        "PurchaseOrderIdByStore": "84WEAPO1061",
        "ReceivingID": -1,
        "DateCommitted": "",
        "ReceiverStoreID": 1,
        "ReceiverStore": "84 West",
        "OrdererStoreID": 1,
        "OrdererStore": "84 West",
        "EstimatedArrivalDate": "2015-07-06T00:00:00",
        "POCommitted": false,
        "POCompleted": false,
        "RowTimeStamp": "AAAAAAAtOeI=",
        "CreatedBy": "iQmetrix Employee",
        "VendorName": "Offwire",
        "ReferenceNumber": "",
        "DaysOnOrder": 0,
        "ModifiedBy": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "PurchaseOrderID": 17388,
            "PurchaseOrderIdByStore": "84WEAPO1061",
            "ReceivingID": -1,
            "DateCommitted": "",
            "ReceiverStoreID": 1,
            "ReceiverStore": "84 West",
            "OrdererStoreID": 1,
            "OrdererStore": "84 West",
            "EstimatedArrivalDate": "2015-07-06T00:00:00",
            "POCommitted": false,
            "POCompleted": false,
            "RowTimeStamp": "AAAAAAAtOeI=",
            "CreatedBy": "iQmetrix Employee",
            "VendorName": "Offwire",
            "ReferenceNumber": "",
            "DaysOnOrder": 0,
            "ModifiedBy": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <PurchaseOrderID>17388</PurchaseOrderID>
    <PurchaseOrderIdByStore>84WEAPO1061</PurchaseOrderIdByStore>
    <ReceivingID>-1</ReceivingID>
    <DateCommitted></DateCommitted>
    <ReceiverStoreID>1</ReceiverStoreID>
    <ReceiverStore>84 West</ReceiverStore>
    <OrdererStoreID>1</OrdererStoreID>
    <OrdererStore>84 West</OrdererStore>
    <EstimatedArrivalDate>2015-07-06T00:00:00</EstimatedArrivalDate>
    <POCommitted>false</POCommitted>
    <POCompleted>false</POCompleted>
    <RowTimeStamp>AAAAAAAtOeI=</RowTimeStamp>
    <CreatedBy>iQmetrix Employee</CreatedBy>
    <VendorName>Offwire</VendorName>
    <ReferenceNumber></ReferenceNumber>
    <DaysOnOrder>0</DaysOnOrder>
    <ModifiedBy></ModifiedBy>
  </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
PurchaseOrderID,PurchaseOrderIdByStore,ReceivingID,DateCommitted,ReceiverStoreID,ReceiverStore,OrdererStoreID,OrdererStore,EstimatedArrivalDate,POCommitted,POCompleted,RowTimeStamp,CreatedBy,VendorName,ReferenceNumber,DaysOnOrder,ModifiedBy
17388,84WEAPO1061,-1,,1,84 West,1,84 West,2015-07-06T00:00:00,false,false,AAAAAAAtOeI=,iQmetrix Employee,Offwire,,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 Transfers in RQ

For more information see Transfers.

Definition

GET /inventory/Transfers?DateAsOf={DateAsOf}&Committed={Committed}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&SearchTerm={SearchTerm}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /inventory/Transfers?DateAsOf=2016-01-01T06:00:00.000Z&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&SearchTerm=84WEATR328&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[Transfer]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "TransferID": 4193,
        "TransferIDByStore": "84WEATR328",
        "DateCommitted": "2015-05-27T08:23:29.59",
        "TransferCompleted": false,
        "Employee_Name": "iQmetrix Employee",
        "StoreFrom": "72 Cornwall",
        "StoreTo": "84 West",
        "DateRequested": "2015-05-27T08:23:29.59",
        "EstimatedArrivalDate": "2015-06-03T00:00:00",
        "TransferCommitted": true,
        "DaysInTransit": 0,
        "Shipped": "No"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "TransferID": 4193,
            "TransferIDByStore": "84WEATR328",
            "DateCommitted": "2015-05-27T08:23:29.59",
            "TransferCompleted": false,
            "Employee_Name": "iQmetrix Employee",
            "StoreFrom": "72 Cornwall",
            "StoreTo": "84 West",
            "DateRequested": "2015-05-27T08:23:29.59",
            "EstimatedArrivalDate": "2015-06-03T00:00:00",
            "TransferCommitted": true,
            "DaysInTransit": 0,
            "Shipped": "No"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <TransferID>4193</TransferID>
    <TransferIDByStore>84WEATR328</TransferIDByStore>
    <DateCommitted>2015-05-27T08:23:29.59</DateCommitted>
    <TransferCompleted>false</TransferCompleted>
    <Employee_Name>iQmetrix Employee</Employee_Name>
    <StoreFrom>72 Cornwall</StoreFrom>
    <StoreTo>84 West</StoreTo>
    <DateRequested>2015-05-27T08:23:29.59</DateRequested>
    <EstimatedArrivalDate>2015-06-03T00:00:00</EstimatedArrivalDate>
    <TransferCommitted>true</TransferCommitted>
    <DaysInTransit>0</DaysInTransit>
    <Shipped>No</Shipped>
  </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
TransferID,TransferIDByStore,DateCommitted,TransferCompleted,Employee_Name,StoreFrom,StoreTo,DateRequested,EstimatedArrivalDate,TransferCommitted,DaysInTransit,Shipped
4193,84WEATR328,2015-05-27T08:23:29.59,false,iQmetrix Employee,72 Cornwall,84 West,2015-05-27T08:23:29.59,2015-06-03T00:00:00,true,0,No

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 RMAs in RQ

For more information see RMA (Return Merchandise Authorizations).

Definition

GET /inventory/RMAs?DateAsOf={DateAsOf}&Committed={Committed}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&VendorID={VendorID}&SearchTerm={SearchTerm}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /inventory/RMAs?DateAsOf=2016-01-01T06:00:00.000Z&Committed=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&VendorID=-1&SearchTerm=84WEAPO1061&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[RMA]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "StockBalanceID": 1147,
        "VendorName": "Offwire",
        "RMANumber": "1234",
        "DateCreated": "2015-07-22T15:16:16.007",
        "ShippedAway": false,
        "CreatedBy": "iQmetrix Employee",
        "StoreName": "84 West",
        "StockBalanceCommitted": true
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "StockBalanceID": 1147,
            "VendorName": "Offwire",
            "RMANumber": "1234",
            "DateCreated": "2015-07-22T15:16:16.007",
            "ShippedAway": false,
            "CreatedBy": "iQmetrix Employee",
            "StoreName": "84 West",
            "StockBalanceCommitted": true
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <StockBalanceID>1147</StockBalanceID>
    <VendorName>Offwire</VendorName>
    <RMANumber>1234</RMANumber>
    <DateCreated>2015-07-22T15:16:16.007</DateCreated>
    <ShippedAway>false</ShippedAway>
    <CreatedBy>iQmetrix Employee</CreatedBy>
    <StoreName>84 West</StoreName>
    <StockBalanceCommitted>true</StockBalanceCommitted>
  </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
StockBalanceID,VendorName,RMANumber,DateCreated,ShippedAway,CreatedBy,StoreName,StockBalanceCommitted
1147,Offwire,1234,2015-07-22T15:16:16.007,false,iQmetrix Employee,84 West,true

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?