Documentation Powered by ReDoc

DataConnect - Partner - Common (1.3.1.42)

The endpoints listed here are provided to be used by the iQmetrix Partners.

DataConnect is a web based connector service you can use to extract data from iQmetrix by making simple web data requests. It provides endpoints for common data requirements, various authentication mechanisms and other utility endpoints.

Introduction

Usage Information

See Usage section.

Security Protocols

We recommend that users use TLS 1.2 when connecting to DataConnect.

Documentation Errata

We appreciate your patience as we work to improve the documentation for DataConnect. If you have noticed a mistake or have a question, please let us know at apisupport [at] iqmetrix [dot] com, subject "Documentation Issue".

Authentication

bearerAuth

Get a token via Obtaining an Access Token. Usage format: Bearer {token}.

Once authenticated, DataConnect will pass back a session cookie. This cookie should be provided on each subsequent data request to make use of your existing session for performance purposes.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Usage

Parameters

All DataConnect endpoints have a series of shared URL/Query Parameters that define specific actions based on the data being passed, such as:

  • Response file type
  • Mode of data delivery
  • Preferred language
  • Response encoding options, etc.

See the Universal Query Parameters and Sample Usage section for examples.

HTTP Method

All DataConnect endpoints support the GET and POST method. There is no functionality change for either method, other than using POST allows you to put the parameters in a request body instead. If the same parameter appears in both the request body and in the URL, preference is given to the URL parameter.

See the Universal Request Payload Parameters and Sample Usage section for examples.

Error Responses

Error Code Description
400 Bad Request - An error indicating the request cannot be understood due to missing parameters.
401 Unauthorized - An error indicating failure to provide a valid token.
403 Forbidden - An error indicating insufficient user access privileges.
404 Not Found - An error indicating that the requested resource was not found.
413 Payload Too Large - DataConnect estimates the number of records that will be returned on a request. If greater than 1,048,576 records (Matches row limit for Microsoft Excel) would be returned, the request is blocked.
429 Too Many Requests (Rate limiting has been applied) - This error occurs for two possible reasons: (1) the number of active concurrent requests on a single resource is dynamically calculated to exceed available capacity or (2) a request has a high risk of impacting business critical systems. For more information, see Rate Limiting.
500 Internal Server Error - This error may indicate issues with the API. Please reach out to us with the details of the issue at apisupport [at] iqmetrix [dot] com, subject "Error Report".

Universal Query Parameters and Sample Usage

This endpoint documentation showcases the universal parameters and error responses shared by all DataConnect endpoints. This endpoint exists for documentation purposes only and is therefore non-functional.

query Parameters
Help
boolean
Default: false
Example: Help=true

When Help=True, the endpoint will return only the technical definition of all the query parameters for the requested endpoint. The response also includes details on how the provided parameters are mapped/converted for execution.

RQ
boolean
Default: false
Example: RQ=true

When RQ=True and the endpoint has an equivalent report in RQ, the fields in the returned response will be renamed to the corresponding columns found in the equivalent RQ report.

Encoding
string
Example: Encoding=utf-8

Providing URL parameter Encoding=utf-8 will encode the response in the utf-8 format.

Response
string
Default: "JSON"
Enum: "JSON" "XML" "CSV" "XMLDataTable" "JSONDataTable" "*.Email" "*.FTP" "*.SFTP" "*.FTPS"
Example: Response=JSONDataTable

This parameter dictates the type of returned response and the mode of delivery.

Response Description
JSON Returns the results in JSON format.
XML Returns the results in XML format.
CSV Returns the results in CSV format.
JSONDataTable Returns the results as well as business descriptions of each field in JSON format.
XMLDataTable Returns the results as well as business descriptions of each field in XML format.
*.Email Where * = [Excel, CSV, XML], returns the result in the chosen file type as an email attachment. This email will be sent from the iQmetrix DataConnect Delivery Service (noreply@iqmetrix.net).

Note: The Email.To parameter becomes required.
*.[FTP, SFTP, FTPS] Where * = [Excel, CSV, XML], returns the result in the chosen file type through an FTP/SFTP/FTPS server.

Note: The following parameters becomes required: $.Host, $.Port, $.Username, $.Password, $.Path where $ = [FTP, SFTP, FTPS]
CSV.Delimiter
string
Default: ","
Example: CSV.Delimiter=|

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

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

Used if Response=[CSV|CSV.Email]. File extension of the returned CSV file.

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

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

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

Semicolon-delimited list of email recipients

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

Used if Response=[CSV,Excel,XML].Email. Semicolon-delimited list of emails to include as CC

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

Used if Response=[CSV,Excel,XML].Email. The subject of the email. Defaults to the resource being requested with the current date.

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

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

Filename
string
Example: Filename=MyReport

Used if Response=[CSV,Excel,XML].Email. Defaults to the resource being requested with today's date

FTP.Host
string
Example: FTP.Host=ftp.domain.com

Required if Response=[Excel,CSV,XML].FTP

FTP.Port
integer
Default: 21
Example: FTP.Port=21

Required if Response=[Excel,CSV,XML].FTP

FTP.Username
string
Example: FTP.Username=Username

Required if Response=[Excel,CSV,XML].FTP.

FTP.Password
string
Example: FTP.Password=Password

Required if Response=[Excel,CSV,XML].FTP.

FTP.Path
string
Default: "/"
Example: FTP.Path=/upload/

Required if Response=[Excel,CSV,XML].FTP.

SFTP.Host
string
Example: SFTP.Host=sftp.domain.com

Required if Response=[Excel,CSV,XML].SFTP.

SFTP.Port
integer
Default: 22
Example: SFTP.Port=22

Required if Response=[Excel,CSV,XML].SFTP

SFTP.Username
string
Example: SFTP.Username=Username

Required if Response=[Excel,CSV,XML].SFTP.

SFTP.Password
string
Example: SFTP.Password=Password

Required if Response=[Excel,CSV,XML].SFTP.

SFTP.Path
string
Default: "/"
Example: SFTP.Path=/upload/

Required if Response=[Excel,CSV,XML].SFTP.

FTPS.Host
string
Example: FTPS.Host=ftps.domain.com

Required if Response=[Excel,CSV,XML].FTPS

FTPS.Port
integer
Example: FTPS.Port=990

Required if Response=[Excel,CSV,XML].FTPS

FTPS.Username
string
Example: FTPS.Username=Username

Required if Response=[Excel,CSV,XML].FTPS

FTPS.Password
string
Example: FTPS.Password=Password

Required if Response=[Excel,CSV,XML].FTPS

FTPS.Path
string
Default: "/"
Example: FTPS.Path=/upload/

Required if Response=[Excel,CSV,XML].FTPS

header Parameters
Accept-Encoding
string
Enum: "gzip" "deflate"
Example: gzip

Compression algorithms are supported for gzip and deflate in the Accept-Encoding header.

Responses

Response samples

Content type
application/json
{
  • "Error": true,
  • "Message": "Procedure or function 'DataConnect_Reports_CashOutSummaryReport' expects parameter '@StopDate', which was not supplied."
}

Universal Request Payload Parameters and Sample Usage

This endpoint documentation showcases the universal parameters shared by all DataConnect endpoints as a request payload. This endpoint exists for documentation purposes only and is therefore non-functional.

Authorizations:
bearerAuth
Request Body schema: application/json
Help
boolean
Default: false

When Help=True, the endpoint will return only the technical definition of all the query parameters for the requested endpoint. The response also includes details on how the provided parameters are mapped/converted for execution.

RQ
boolean
Default: false

When RQ=True and the endpoint has an equivalent report in RQ, the fields in the returned response will be renamed to the corresponding columns found in the equivalent RQ report.

Encoding
string

Providing URL parameter Encoding=utf-8 will encode the response in the utf-8 format.

Response
string
Default: "JSON"

See Response Query Parameter of Sample Usage Endpoint.

JSON
XML.FTPS
Excel.FTPS
CSV.FTPS
XML.SFTP
Excel.SFTP
CSV.SFTP
XML.FTP
Excel.FTP
CSV.FTP
XML.Email
Excel.Email
CSV.Email
JSON
XML
CSV
XMLDataTable
JSONDataTable

Responses

Request samples

Content type
application/json
Example
JSON
JSON
XML
JSONDataTable
XMLDataTable
CSV
CSV.Email
Excel.Email
XML.Email
CSV.FTP
Excel.FTP
XML.FTP
CSV.SFTP
Excel.SFTP
XML.SFTP
CSV.FTPS
Excel.FTPS
XML.FTPS
{
  • "Help": true,
  • "RQ": true,
  • "Encoding": "utf-8",
  • "Response": "JSON"
}

Ping

This unsecured endpoint returns the current API version of DataConnect

Responses

Response samples

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

Session Information

This endpoint is used to get the current session information.

The PreferredEndpoint property in the response provides the URL you should use for each client for optimal results. While this usage is optional it is recommended for the lowest latency for processing requests.

Authorizations:
bearerAuth

Responses

Response samples

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

Requests

This endpoint returns logs of all DataConnect requests made for a time period from your company.

Authorizations:
bearerAuth
query Parameters
StartDate
string <date>
Example: StartDate=2019-06-01T10:06:35.133

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

isException
boolean
Example: isException=false

A flag to return only requests that returned an error (True)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers

Customers

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

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

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

The initial date and time of the search period, specified in UTC. Filters based on LastUpdatedDate.

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

The end date and time of the search period, specified in UTC. Filters based on LastUpdatedDate.

EmployeeID
integer
Example: EmployeeID=12345

Internal identifier of the employee associated with the Customer. For a list of acceptable values, see Employees.

CustomerEntityID
string <guid>
Example: CustomerEntityID=5510286c-d32b-4b8a-9d58-46707e72c7eb

Unique identifier for a Customer in the iQmetrix CRM API.

CustomerID
integer
Example: CustomerID=132255

Internal identifier of the customer in RQ.

PrimaryName
string
Example: PrimaryName=John

First name of the customer

FamilyName
string
Example: FamilyName=Doe

Last name of the customer

CompanyName
string
Example: CompanyName=Kentel

Company name

CustomerTypeID
integer
Enum: 0 3
Example: CustomerTypeID=0
  • 0: Company
  • 3: Individual
Phone
string
Example: Phone=5555555555

Phone of the customer

Email
string
Example: Email=test@test.com

Email of the customer

RowThumbprint
string <guid>
Example: RowThumbprint=38dc37d2-853a-4343-8518-93a44989243a

Unique identifier of a thumbprint

MemberNumber
string
Example: MemberNumber=R415T671101

Member number of the customer

RowEvent
string
Enum: "Inserted" "Updated"
Example: RowEvent=Updated

Type of event.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customer List Report

The Customer List Report endpoint lets you view new customers that have been created in RQ within a specified date range. This includes information on the employee that made contact with the customer.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

TypeOfCustomer
required
integer
Enum: 0 3
Example: TypeOfCustomer=0
  • 0: Company
  • 3: Individual
FilterBy
required
integer [ 0 .. 2 ]
Example: FilterBy=0
  • 0: Filter by all Customers
  • 1: Filter by First Activations
  • 2: Filter by Sales
StoreIDLoggedIn
required
string
Example: StoreIDLoggedIn=1

Internal identifier of a store in RQ. For a list of acceptable values, see Stores.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

StartDateLastModified
string <date>
Example: StartDateLastModified=2020-01-01

Initial date and time of the last time that the record was modified

StopDateLastModified
string <date>
Example: StopDateLastModified=2020-01-01

End date and time of the last time that the record was modified

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Operations

Location Master List Report

The Location Master List endpoint returns a comprehensive list of all created locations in RQ that satisfies the provided parameters.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

StartDateLastModified
string <date>
Example: StartDateLastModified=2020-01-01

Initial date and time of the last time that the record was modified

StopDateLastModified
string <date>
Example: StopDateLastModified=2020-01-01

End date and time of the last time that the record was modified

StoreID
string
Example: StoreID=1

Internal identifier of a store in RQ. For a list of acceptable values, see Stores.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales

Activation Gross Profit Report

The Activation Gross Profit Report endpoint allows you to view the Gross Profit of activations based on sales made through the Phone Activation Wizard.

An activation is anything that goes through the PAW (Phone Activation Wizard) with the same association number. Items that are added to the invoice outside of the PAW cannot be tied to an Activation and therefore will not be considered in the calculation.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

StoreType
required
string
Example: StoreType=-1

Internal identifier for a StoreType. Use -1 to specify All Types. For a list of acceptable values, see Store Types.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

ReasonCode
string
Default: "-1"
Example: ReasonCode=-1

Internal identifier for an Inventory Adjustment Reason Code. Use -1 to specify All Reason Codes. For a complete list, see Inventory Adjustment Reason Code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Coupon Summary Report

The Coupon Summary Report endpoint returns comprehensive list of information on all recorded coupon transactions in RQ. See parameter ReportType for more information.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

ReportType
required
string
Enum: "DailySummary" "LocationSummary" "CouponSummary" "CouponDetail" "EmployeeSummary" "CommissionDetail"
Example: ReportType=DailySummary
  • DailySummary: CouponSummaryReportData_DailySummary
  • LocationSummary: CouponSummaryReportData_LocationSummary
  • CouponSummary: CouponSummaryReportData
  • CouponDetail: CouponSummaryReportData_CouponDetail
  • EmployeeSummary: CouponSummaryReportData_EmployeeSummary
  • CommissionDetail: CouponSummaryReportData_CommissionDetail

This URL parameter changes the returned response. See successful response schemas below for more information.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Discount Summary Report

The Discount Summary Report endpoint returns a list of per product transactions with discounts applied on it. This allows you to view detailed historical pricing and discount information for every recorded transaction in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

CategoryNumber
string
Example: CategoryNumber=10

Internal identifier for a CategoryNumber in RQ. For a list of acceptable values, see Category Number. For all categories, use 10. Used when searching by Category.

ShowRefunds
boolean
Default: false
Example: ShowRefunds=false

a flag to indicate if the report should include refunds

ShowOrderEntryDiscounts
boolean
Default: false
Example: ShowOrderEntryDiscounts=false

a flag to indicate if the report should include Sales Order Discounts

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invoice History Report

The Invoice History Report endpoint returns historical transaction data on the provided ReportType.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

InvoiceStatus
required
integer [ -1 .. 3 ]
Example: InvoiceStatus=-1
  • -1: All
  • 0: Tendering
  • 1: Failed
  • 2: Incomplete
  • 3: Tendered
SearchType
required
integer [ 0 .. 1 ]
Example: SearchType=0

Search by Invoice (0) or by Location (1)

ReportType
required
string
Enum: "ByProduct" "ByInvoice"
Example: ReportType=ByProduct
  • ByProduct: ByProduct response
  • ByInvoice: ByInvoice response

This URL parameter changes the returned response. See successful response schemas below for more information.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Detail (Sales by Product)

The Product Detail Report endpoint allows you to view the detailed history of all sales transactions in RQ summarized per product. See ReportPart for more details on the returned response.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

SearchMethod
required
integer [ 1 .. 6 ]
Example: SearchMethod=3

Search by the following:

  • 1: Product SKU (ProductIdentifier is required)
  • 2: Manufacturer (ManufacturerID is required)
  • 3: Category (CategoryNumber is required)
  • 4: Invoice No. (InvoiceIDByStore is required)
  • 5: Customer ID (CustomerIDs is required)
  • 6: Serial Number (SerialNumbers is required)
ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

Product SKU. For a list of acceptable values, see Product Identifier.

ManufacturerID
string
Example: ManufacturerID=1

Internal identifier for a Manufacturer in RQ. Use -1 for all Manufacturers. For a list of acceptable values, see Manufacture ID.

CategoryNumber
string
Example: CategoryNumber=10

Internal identifier for a CategoryNumber in RQ. For a list of acceptable values, see Category Number. For all categories, use 10. Used when searching by Category.

InvoiceIDByStore
string
Example: InvoiceIDByStore=52POGG18737

Invoice ID generated and as seen in RQ

CustomerIDs
integer
Example: CustomerIDs=114033

Comma separated list of internal identifiers for customers in RQ. For a list of acceptable values, see Customers.

SerialNumbers
string
Example: SerialNumbers=1234343434

Comma-separated list of SerialNumbers

ReportPart
integer [ 1 .. 3 ]
Example: ReportPart=1
  • 1: ProductDetailReportData (default report)
  • 2: ProductDetailReportTaxDetailData (tax detail)
  • 3: ProductDetailReportTaxColumnData (tax column data)

This URL parameter changes the returned response. See successful response schemas below for more information.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Refund Summary Report

The Refund Summary Report endpoint returns all refunds within a specific time frame. You can use it to audit and track refund deviances within your database.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

Filter
required
integer [ 0 .. 3 ]
Example: Filter=0
  • 0: Any Balance
  • 1: Positive Balance
  • 2: Negative Balance
  • 3: Zero Balance
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales By Invoice Report

The Sales by Invoice Report endpoint lets you review all the invoices for the whole company or for a particular region, district, location or even an individual employee for any date range.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

HideRebates
required
integer
Value: 1
Example: HideRebates=1

Constant value

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

InvoiceSourceType
integer
Enum: 0 15
Example: InvoiceSourceType=0

0 for tendered in RQ, 15 for tendered in RQ Mobile

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Serialized Coupon Report

The Serialized Coupon Report endpoint details outstanding and redeemed serialized coupons as recorded in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

Enabled
required
boolean
Example: Enabled=false

A flag to indicate if the report should search by Enabled coupons (true) or Disabled (false)

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

SerialNumberFilter
string
Example: SerialNumberFilter=1234567890

A text field that allows you to search for specific serial numbers

CouponID
integer
Default: -1
Example: CouponID=853

Internal identifier for a Coupon in RQ. For a complete list, see Coupon ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory

Product Master List

The Product Master List endpoint returns a comprehensive list of all created products in RQ that satisfies the provided parameters.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

StoreIDLoggedIn
required
string
Example: StoreIDLoggedIn=1

Internal identifier of a store in RQ. For a list of acceptable values, see Stores.

ProductType
required
string
Example: ProductType=0

Product type. For a list of acceptable values, see Product Type.

SearchMethod
required
integer
Enum: 0 1 2 3 8
Example: SearchMethod=0

Method to search the list by.

  • 0: search by Category
  • 1: search by Vendor
  • 2: search by Manufacturer
  • 3: search by Keyword.
  • 8: search for zero-quantity items in the system, see Category Number.

Use the accompanying required field SearchCriteria for the search value e.g. SearchMethod=3&SearchCriteria=iPhone

SearchCriteria
required
string
Example: SearchCriteria=10

Value for searching, based on the provided SearchMethod.

Enabled
required
integer [ 0 .. 2 ]
Example: Enabled=0
  • 0: Include disabled products only
  • 1: Include enabled products only
  • 2: All
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Term Details Report

The Term Details Report endpoint returns term details for all Price Sheets in your database.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

SearchDate
string <date>
Example: SearchDate=2020-01-01T00:00:00.000Z
  • Enter today's date to retrieve all currently active Price Sheets.
  • To view historical data, enter a date within the Price Sheet's available date range. This will return both currently active Price Sheets and those that were active on the specified date.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Auto Punch Out Report

The Auto Punch Out Report endpoint allows you to review a complete list of punches which were automatically done by the software rather than manually by the employee.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee List Report

The Employee List Report endpoint allows you to view a complete listing of all employees by Company, Channel, Region, District or Location, as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Unique
required
boolean
Example: Unique=true

A flag to indicate if employees should be shown only once no matter how many stores they are in.

GroupID
required
string
Example: GroupID=-1

Internal identifier for an Employee group in RQ. For a list of acceptable values, see Group ID.

Status
required
integer [ 0 .. 2 ]
Example: Status=0
  • 0: Disabled
  • 1: Enabled
  • 2: Any status
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

StartDateLastModified
string <date>
Example: StartDateLastModified=2020-01-01

Initial date and time of the last time that the record was modified

StopDateLastModified
string <date>
Example: StopDateLastModified=2020-01-01

End date and time of the last time that the record was modified

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee Master List Report

The Employee Master List report endpoint returns a comprehensive list of employee information for the given parameters.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

EnabledStatus
required
integer [ 0 .. 2 ]
Example: EnabledStatus=0
  • 0: Disabled
  • 1: Enabled
  • 2: Any status
LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance

Cash Outs

This endpoint returns a list of all Cash Outs recorded in RQ for the given parameters.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Commission

Vendor Rebate History Report

The Vendor Rebate History Report endpoint gives a complete audit trail of vendor rebates charged and reconciled. This endpoint enables you to easily find the vendor rebates associated with specific tracking numbers, product SKUs, or vendor accounts, as well as quickly determine the total quantities and rebate amounts for any time period.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

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

Initial date and time of the search period. As another option, you can use DateRange parameter instead. See Date Range for usage and a list of acceptable values.

StopDate
required
string <date>
Example: StopDate=2019-12-31

End date and time of the search period.

ReconciledStatus
required
integer [ 0 .. 2 ]
Example: ReconciledStatus=0
  • 0: Unreconciled
  • 1: Reconciled
  • 2: Any
RemoveRefunds
required
boolean
Example: RemoveRefunds=false

A flag to indicate if refunds should be removed from the results.

SearchMethod
required
integer [ 1 .. 6 ]
Example: SearchMethod=1
  • 1: Vendor Account (VendorAccountID is required)
  • 2: Journal Number (JournalNumber is required)
  • 3: Reconciled By (EmployeeIDOfReconcilers is required)
  • 4: Category (CategoryNumber is required)
  • 5: Tracking Number (SerialNumber is required)
  • 6: Product SKU (ProductIdentifier is required)
VendorAccountID
integer
Example: VendorAccountID=-1

When searching by Vendor Accounts, identifier for a Vendor Account. -1 for all Vendor Accounts. For a complete list, see Vendor Account ID.

JournalNumber
string
Example: JournalNumber=1007

Journal Number for a Vendor Account

EmployeeIDOfReconcilers
string
Example: EmployeeIDOfReconcilers=5231

Internal identifier for the Employee who reconciled the rebate. For a list of acceptable values, see Employees.

CategoryNumber
string
Example: CategoryNumber=10

Internal identifier for a CategoryNumber in RQ. For a list of acceptable values, see Category Number. For all categories, use 10. Used when searching by Category.

SerialNumber
string
Example: SerialNumber=1234567890

Tracking Number for a RQ Product

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

Product SKU. For a list of acceptable values, see Product Identifier.

ApplyShowOnInvoice
boolean
Default: false
Example: ApplyShowOnInvoice=false

A flag to indicate if products with the "Hide On Invoice/Sales Order" pricing attribute should be displayed.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attributes

Attachment Rates

Returns a list of Attachment Rates as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

AttachmentRateIntId
integer
Example: AttachmentRateIntId=4

ID of the Attachment Rate.

Enabled
boolean
Example: Enabled=true

A flag to indicate if disabled Attachment Rates should be included or not.

Hidden
boolean
Example: Hidden=false

A flag to indicate if hidden Attachment Rates should be included or not.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Date Range

For requests that include parameters of StartDate & StopDate, the parameter of DataRange is also supported as an alternative, more convenient way to define the StartDate & StopDate using common terms. This endpoint returns a list of supported values of each date range and the calculated result of each.

Example usage: ?DateRange=Yesterday

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Languages

Returns a pre-configured list of supported languages in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Identifiers

Vendor Account ID

Returns a list of all Vendor Accounts.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
{
  • "RecordsSet1": [
    ],
  • "RecordsSet2": [
    ]
}

Bill Pay Provider ID

Returns a list of Bill Pay providers as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cash Audit Trail Type ID

Returns a pre-configured list of Cash Audit Trail transaction types.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Coupon ID

Returns a list of Coupons as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Discount Level ID

Returns a list of Multi-Level Pricing discount types as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Financing Detail ID

Returns a list of Financing options as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Group ID

Returns a list of Employee Groups as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Integration Provider ID

Returns a pre-configured list of available Integration Providers.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Location Type ID

Returns a list of acceptable values to be used by endpoints with a LocationTypeIDs parameter.

In RQ, all stores (physical and virtual) are organized into a Company Tree structure. Using this endpoint, you can filter reports - for example, you can use LocationTypeID on a report to filter to two Regions (e.g. ?LocationType=Region&LocationTypeIDs=5,2).

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Manufacture ID

Returns a list of Manufacturers as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Non-Sellable Reason Code

Returns a list of non sellable reason codes configured in RQ. Non-Sellable Product Reason Codes can be set up and used within RQ in an effort to better track and provide additional detail when serialized products are refunded and categorized as "non-sellable".

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payment Type ID

Returns a list of Payment Method types as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

ForWhat
string
Example: ForWhat=8

For the Cash Audit Report, use 8

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Identifier

Returns a list of all created/configured products in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

IncludeDisabled
boolean
Default: false
Example: IncludeDisabled=false

A flag to indicate if disabled products should be included (true) or not (false)

CategoryNumbers
string
Example: CategoryNumbers=10

Comma separated list of CategoryNumbers to be used to filter the products. For a complete list, see Category Number.

SearchTerm
string
Example: SearchTerm=iPhone X

Will search for SearchTerm within the Description and ID fields

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reason Code

Returns a list of Inventory Adjustment Reason Codes as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tax ID

Returns a list of Taxes as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Trade-In Provider ID

Returns a list of available Trade-in Providers.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Vendor ID

Returns a list of Vendors (Suppliers) configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Type Definitions

Card Types

Returns a pre-configured list of Credit Card types.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entry Types

Returns a pre-configured list of Payment Entry types.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

G/L Source Type

Returns a pre-configured list of G/L Transaction types in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Location Type

Returns a list of acceptable values to be used by endpoints with a LocationType parameter.

In RQ, all stores (physical and virtual) are organized into a Company Tree structure. Using this endpoint, you can filter reports - for example, you can use LocationType on a report to filter to a single Region (?LocationType=Region).

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Type

Returns a list of acceptable values for reports with a ProductType parameter.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Opportunity Type

Returns a list of Sales Opportunity types as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Types

Returns a list of Service Request types as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Store Types

Returns a list of Location Types as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Groups

Category Number

Returns a list of Product Categories as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

IncludeDisabled
boolean
Example: IncludeDisabled=false

A flag to indicate if disabled categories should be included or not.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Commission Groups

Returns a list of Commission Groups as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Performance Groups

Returns a list of performance groups configured in RQ. Performance Groups are groups of Product SKUs which are related to each other and when put together, generate a metric. Performance groups are used in the Performance Metrix Report and Performance Group Report endpoints.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

GroupID
integer
Example: GroupID=21

ID of the Performance Group

TargetLevel
integer [ 1 .. 6 ]
Example: TargetLevel=1
  • 1: Company
  • 2: Region
  • 3: District
  • 4: Store
  • 5: Employee
  • 6: Channel
GroupDefinitionID
integer
Example: GroupDefinitionID=15

ID of the Group Definition

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entities

Carriers

Returns a pre-configured list of Carriers.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Returns a summarized list of Employees as configured in RQ.

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stores

Returns a list of stores configured in RQ. Stores can be both physical (such as brick and mortar) and virtual (such as eCommerce)

Authorizations:
bearerAuth
query Parameters
CompanyID
required
integer
Example: CompanyID=235929

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
integer
Default: "-1"
Example: LocationTypeIDs=11

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see Location Type ID.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Relationships

Relationships

This endpoint returns a list of RQ databases a partner has access to.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]