Documentation Powered by ReDoc

DataConnect (1.3.1.42)

DataConnect is a web-based connector service you can use to extract data from iQmetrix by making simple HTTP requests. It provides endpoints for common data requirements, various authentication mechanisms, and other utility endpoints. This API provides you a catalog of retailer data sets designed to meet your simple to complex reporting needs and is the perfect tool for your data analyst to quickly derive insights about your retail operations.

Introduction

Usage Information

See Usage section.

Security Protocols

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

Sign Up

To sign-up, contact your account manager for pricing and onboarding with DataConnect.

Release Notes

Release Notes for Data Connect can be found on the API Release Notes page.

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 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" "JSONDataTable" "XML" "XMLDataTable" "CSV" "Excel" "Excel.Email" "CSV.Email" "XML.Email"
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.
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

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.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
{
  • "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
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
[
  • {
    }
]

Activity Tracking

The Activity Tracking Report endpoint returns all recorded activities in RQ for the provided date range. You can use the described Query Parameters below to refine your search.

Authorizations:
bearerAuth
query Parameters
UseDateCreatedSearchParameters
required
boolean
Example: UseDateCreatedSearchParameters=false

A flag to indicate if UseDateCreatedSearchParameters should be included in search or not.

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

Date at which to begin filtering Created Date

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

Date at which to stop filtering Created Date

UseDateClosedSearchParameters
required
boolean
Example: UseDateClosedSearchParameters=false

A flag to indicate if UseDateClosedSearchParameters should be included in search or not.

DateClosedStartDate
required
string <date>
Example: DateClosedStartDate=2019-01-01 12:00:00

Date at which to begin filtering Closed Date

DateClosedStopDate
required
string <date>
Example: DateClosedStopDate=2019-01-01 12:05:00

Date at which to begin filtering Closed Date

UseAssignedToSearchParameters
required
boolean
Example: UseAssignedToSearchParameters=false

A flag to indicate if UseAssignedToSearchParameters should be included in search or not.

AssignedToType
required
integer [ 1 .. 2 ]
Example: AssignedToType=1
  • 1: Assigned to Employee. Used with AssignedToEmployeeIDs parameter.
  • 2: Assigned to Commission Group. Used with AssignedToGroupID parameter.
AssignedToEmployeeIDs
required
string
Example: AssignedToEmployeeIDs=5123

Comma separated list of identifiers of the assigned employee. For a list of acceptable values, see Employees.

AssignedToGroupID
required
string
Example: AssignedToGroupID=-1

Internal identifier for the assigned Group in RQ, use -1 for All groups. For a complete list, see Group ID.

UseCreatedBySearchParameters
required
boolean
Example: UseCreatedBySearchParameters=false

A flag to indicate if UseCreatedBySearchParameters should be included in search or not.

CreatedByType
required
integer [ 1 .. 2 ]
Example: CreatedByType=1
  • 1: Created by Employee. Used with CreatedByEmployeeIDs parameter.
  • 2: Created by Commission Group. Used with CreatedByGroupID parameter.
CreatedByEmployeeIDs
required
string
Example: CreatedByEmployeeIDs=5123

Comma separated list of identifiers of the created by employee. For a list of acceptable values, see Employees.

CreatedByGroupID
required
string
Example: CreatedByGroupID=-1

Internal identifier for the created by Group in RQ, use -1 for All groups. For a complete list, see Group ID.

UseForWhoSearchParameters
required
boolean
Example: UseForWhoSearchParameters=false

A flag to indicate if LocationType and LocationTypeIDs should be included in search or not.

UseStatusTypeSearchParameters
required
boolean
Example: UseStatusTypeSearchParameters=false

A flag to indicate if StatusType should be included in search or not.

StatusType
required
integer [ -1 .. 3 ]
Example: StatusType=0

Activity Status.

  • -1: Any status
  • 0: Open
  • 1: Pending
  • 2: Completed
  • 3: Cancelled
UseActivityTypeSearchParameters
required
boolean
Example: UseActivityTypeSearchParameters=false

A flag to indicate if ActivityTypeID should be included in search or not.

ActivityTypeID
required
string
Example: ActivityTypeID=-1

Internal identifier for a Activity Type in RQ, use -1 for all Activity Types. For a complete list, see Activity Type ID.

UseContactNameSearchParameters
required
boolean
Example: UseContactNameSearchParameters=false

A flag to indicate if UseContactNameSearchParameters should be included in search or not.

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.

CustomerName
string
Example: CustomerName=Jane Doe

Name of the customer to search

ContactName
string
Example: ContactName=John Doe

Name of the contact to search

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customer Contact Status

The Customer Contact Status Report endpoint returns information for all customers in your database who have some type of "No Contact" instructions in their customer profile.

Authorizations:
bearerAuth
query Parameters
TypeOfSelection
required
integer [ 1 .. 4 ]
Example: TypeOfSelection=1

Type of Customer Contact.

  • 1: All types
  • 2: No Calls
  • 3: No Email
  • 4: No Mail
StoreID
required
string
Example: StoreID=1

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

EmployeeID
integer
Example: EmployeeID=12345

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

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

Customer Activities

This endpoint returns all Customer Activities recorded in RQ for the given parameters.

Authorizations:
bearerAuth
query Parameters
DateAsOf
required
string <date>
Example: DateAsOf=2020-01-01

Date at which to search for Customer Activities

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 Opportunities

This endpoint returns all Sales Opportunities recorded in RQ for the given parameters.

Authorizations:
bearerAuth
query Parameters
DateAsOf
required
string <date>
Example: DateAsOf=2020-01-01

Date at which to search for Customer Activities

SalesOpportunityType
required
integer
Example: SalesOpportunityType=-1

Internal identifier for a SalesOpportunityType in RQ. Use -1 to specify All Types. For a list of acceptable values, see Sales Opportunity Type

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
[
  • {
    }
]

Service Requests

This endpoint returns all Service Requests/Repair recorded in RQ for the given parameters.

Authorizations:
bearerAuth
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Request History Report

The Service Request History Report endpoint lets you view any or all Service Requests recorded in RQ for your database.

Authorizations:
bearerAuth
query Parameters
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.

Status
required
integer [ -1 .. 3 ]
Example: Status=-1

Service Request status.

  • -1: Any status
  • 0: Open
  • 1: Pending
  • 2: Completed
  • 3: Cancelled
ServiceType
required
integer
Example: ServiceType=2

Use -1 for all Service Types. For a list of acceptable values, see Service Types.

DateToSearch
required
integer <date> [ 1 .. 2 ]
Example: DateToSearch=2
  • 1: Search dates based on creation dates
  • 2: Search dates based on due date
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.

StartExpiryDate
string <date>
Example: StartExpiryDate=2019-10-01T18:15:00.000

Date at which to begin searching Expiry Date

StopExpiryDate
string <date>
Example: StopExpiryDate=2019-11-01T18:45:00.000

Date at which to end searching Expiry Date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
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
[
  • {
    }
]

Location Tree Report

The Location Tree Report endpoint returns the Location Tree and related details from RQ.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Sales

Bill Payment Transactions

This endpoint returns a list of all the Bill Pay Transactions that satisfies the provided parameters

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.

BillPayInvoice
string
Example: BillPayInvoice=84WEABP781

Identifier for a Bill Payment Transaction or known as the Bill Pay Invoice in RQ.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Performance Metrix Report

The Performance Metrix Report endpoint displays actual sales vs. targets for all performance groups for a selected node in the company tree.

Trending is defined as the projected sales for a period, calculated by taking the average sales per day to the current date and multiplying by the number of days in the period.

Authorizations:
bearerAuth
query Parameters
DateAsOf
required
string <date>
Example: DateAsOf=2020-01-01

Date at which to run report

HideRebates
required
integer
Enum: -1 1
Example: HideRebates=1

A flag to indicate if Rebates should be included in the report (1) or not (-1)

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
[
  • {
    }
]

Performance Metrix Summary Report

The Performance Metrix Summary Report endpoint provides a summarized view of sales performance compared to targets across different dimensions of your business. This report allows you to quickly analyze performance metrics across the organization and identify areas that need attention.

Authorizations:
bearerAuth
query Parameters
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: "all" "employee" "group" "location" "performancegroup"
Example: ReportType=all

Determines how the report data is organized:

  • all: Shows performance for all available dimensions
  • employee: Shows performance organized by employee
  • group: Shows performance organized by employee groups
  • location: Shows performance organized by locations
  • performancegroup: Shows performance organized by performance groups
HideRebates
required
integer
Enum: -1 1
Example: HideRebates=1

A flag to indicate if Rebates should be included in the report (1) or not (-1)

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
Example
group
group
employee
location
performancegroup
[
  • {
    }
]

Performance Group Report

The Performance Group Report will display actual sales vs. targets of one group for children of the selected node.

Trending is defined as the projected sales for a period, calculated by taking the average sales per day to the current date and multiplying by the number of days in the period.

Authorizations:
bearerAuth
query Parameters
DateAsOf
required
string <date>
Example: DateAsOf=2020-01-01

Date at which to run report

PerformanceGroupID
required
string
Example: PerformanceGroupID=412

Internal identifier for a Performance Group in RQ. For a list of acceptable values, see Performance Groups.

TopN
required
string
Example: TopN=-1

Gets the top X entries for the report, ordered by the value in TopCriteria. Use -1 to return all results

TopCriteria
required
string
Enum: "Quantity" "Sales" "Profit" "Margin" "Rate"
Example: TopCriteria=Quantity

View the report by this criteria.

ByWho
required
integer [ 1 .. 5 ]
Example: ByWho=1

This parameter aggregates the report data at the following level:

  • 1: Company
  • 2: Region
  • 3: Division
  • 4: Location
  • 5: Employee
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
[
  • {
    }
]

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
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.

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
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
[
  • {
    }
]

Daily Sales Summary Report

The Daily Sales Summary Report endpoint returns recorded sales information summarized by daily totals.

Authorizations:
bearerAuth
query Parameters
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.

SpecialProductID
required
integer [ -1 .. 5 ]
Example: SpecialProductID=-1

Filter by the following products:

  • -1: All Products
  • 0: Regular Products
  • 1: Vendor Rebates
  • 2: Non-Stocked Products
  • 3: Gift Cards
  • 4: Non-Revenue Products
  • 5: Specific product (use ProductIdentifier to specify SKU)
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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

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

The Invoice Edit Summary Report endpoint returns a detailed list of all edited invoices in RQ that satisfies the given parameters.

Authorizations:
bearerAuth
query Parameters
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: "Invoice" "Product"
Example: ReportType=Invoice
  • Invoice: InvoiceEditSummary_Invoice
  • Product: InvoiceEditSummary_Product

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
[
  • {
    }
]

Invoice History Report

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

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

PAW Exceptions Report

The PAW Exceptions Report endpoint displays all activations that went through the Phone Activation Wizard (PAW) in RQ but disagreed with the imported activation data from the carrier through Carrier Integration.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

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
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
[
  • {
    }
]

Product Financing Report

The Product Financing Report endpoint returns data on products sold as a part of a Financing Program in RQ.

Authorizations:
bearerAuth
query Parameters
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.

FinancingID
required
string
Example: FinancingID=-1

Internal identifier for a financing type in RQ. Use -1 for all types. For a list of acceptable values, see Financing Detail ID.

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.

CarrierSIPNumbering
integer
Example: CarrierSIPNumbering=1

Identifier for a carrier in RQ. For a list of acceptable values, see Carriers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Summary Report

The Product Summary Report endpoint returns sales information summarized per product SKU in RQ.

Authorizations:
bearerAuth
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales By Category Report

The Sales by Category Report endpoint returns sales information grouped by the product category.

Authorizations:
bearerAuth
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales By Employee Report

The Sales by Employee Report endpoint returns sales information summarized by the employee.

Authorizations:
bearerAuth
query Parameters
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.

AssignedGroupID
required
string
Example: AssignedGroupID=-2

Internal identifier for an assigned group in RQ. -2 to all groups. For a complete list, see Group ID.

CommissionGroupID
required
string
Example: CommissionGroupID=-2

Internal identifier for a commission in RQ. -2 to all groups. For a complete list, see Commission Groups.

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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

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
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
[
  • {
    }
]

Sales By Location Report

The Sales by Location Report endpoint lets user view sales information and performance per location.

Authorizations:
bearerAuth
query Parameters
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 .. 9 ]
Example: SearchMethod=1

Search by the following:

  • 1: All Products
  • 2: Regular Products
  • 3: Vendor Rebate Products
  • 4: Non-Stocked Products
  • 5: Gift Card Products
  • 6: Products In This Category (CategoryNumber is required)
  • 7: One Product (ProductIdentifier is required)
  • 8: Coupons (CouponIDs is required)
  • 9: Non-Revenue Products
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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

CouponIDs
string
Example: CouponIDs=10,1010

Comma separated list of coupon identifiers. For a list of acceptable values, see Coupon ID.

StoreTypeID
string
Example: StoreTypeID=1

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

ByDate
string
Value: "ByMonth"
Example: ByDate=ByMonth

Accepts ByMonth only

CommissionGroupID
string
Default: "-2"
Example: CommissionGroupID=1

Internal identifier for a commission in RQ. -2 to all groups. For a complete list, see Commission Groups.

AssignedGroupID
string
Example: AssignedGroupID=4

Internal identifier for an assigned group in RQ. Defaults to all groups. For a complete list, see Group ID.

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 Order Detail Report

The Sales Order Detail Report endpoint returns detailed information on all Sales Orders that satisfies the provided parameter/s.

Authorizations:
bearerAuth
query Parameters
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

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.

Status
integer [ 0 .. 3 ]
Default: 0
Example: Status=0
  • 0: All
  • 1: Committed
  • 2: Cancelled
  • 3: Completed
LocationEntityID
integer
Example: LocationEntityID=664321

Identifier for a Location in Entity Store. For a list of acceptable values, see Location Type ID.

OrderEntryIDByStore
string
Example: OrderEntryIDByStore=84WEAOE374

Identifier for a Sales Order in RQ

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Order Summary Report

The Sales Order Summary Report endpoint returns a summary of all Sales Orders that satisfies the provided parameter/s.

Authorizations:
bearerAuth
query Parameters
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.

Status
required
integer [ 0 .. 3 ]
Example: Status=0
  • 0: All
  • 1: Committed
  • 2: Cancelled
  • 3: Completed
SearchMethod
required
integer [ 1 .. 3 ]
Example: SearchMethod=1
  • 1: By Customer (CustomerID is required)
  • 2: By Order Entry No. (OrderEntryIDByStore is required)
  • 3: By Company Tree (LocationTypeIDs is required)
CustomerID
integer
Example: CustomerID=114033

Internal identifier for a Customer in RQ. For a list of acceptable values, see Customers.

OrderEntryIDByStore
string
Example: OrderEntryIDByStore=84WEAOE374

Identifier for a Sales Order in RQ.

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.

LocationType
string
Example: LocationType=Company

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

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
[
  • {
    }
]

Serialized Coupon Report

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

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Refund Summary Report

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

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Inventory

Availability of Product

This endpoint returns availability information for all products configured in RQ. You can use the described Query Parameters below to refine your search.

Note: If the Query Parameters LocationType and LocationTypeID are not included in the API call, the response will not include LocationId. See the documented response schemas below for more information.

Authorizations:
bearerAuth
query Parameters
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.

ProductType
string
Enum: "Serialized" "Non-Serialized"
Example: ProductType=Serialized

Type of product according to serialization

ByLocation
boolean
Default: false
Example: ByLocation=true

A flag to indicate if the results should return location information. See AvailabilityofProduct_byLocation in the successful responses below for more information.

ProductSKUs
string
Example: ProductSKUs=ACPHLG000135,ACPHRI000170,ASBOLG000012

Comma-separated list of Product SKUs. For a list of acceptable values, see Product Identifier.

CatalogItemIDs
string <guid>
Example: CatalogItemIDs=a183f1a9-c58f-426a-930a-9a6357db52ed

Comma-separated list of identifiers for products in the iQmetrix Catalog API.

ProductLibraryIDs
string
Example: ProductLibraryIDs=M12512,M55321

Comma-separated list of identifiers for Products in the iQmetrix Product Library

ProductNames
string
Example: ProductNames=iPhone XS Max 128 GB

Comma-separated list of Product Names

SerialNumbers
string
Example: SerialNumbers=1234343434

Comma-separated list of SerialNumbers

BarCodes
string
Example: BarCodes=822445090459

Comma-separated list of Bar Codes

VendorSKUs
string
Example: VendorSKUs=6025A_POIIU

Comma separated list of Vendor identifiers

QuantityMin
integer
Example: QuantityMin=1

When provided, will return products with Quantity >= QuantityMin

QuantityMax
integer
Example: QuantityMax=5

When provided, will return products with Quantity <= QuantityMax

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pricing of Product

This Product Pricing endpoint returns pricing information for Product Library-mapped products as configured in RQ.

Authorizations:
bearerAuth
query Parameters
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.

ProductType
string
Example: ProductType=0

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

CatalogItemIDs
string <guid>
Example: CatalogItemIDs=a183f1a9-c58f-426a-930a-9a6357db52ed

Comma-separated list of identifiers for products in the iQmetrix Catalog API.

ProductLibraryIDs
string
Example: ProductLibraryIDs=M12512,M55321

Comma-separated list of identifiers for Products in the iQmetrix Product Library

ProductNames
string
Example: ProductNames=iPhone Max X 128GB

Comma-separated list of Product Names

ProductSKUs
string
Example: ProductSKUs=ACPHLG000135,ACPHRI000170,ASBOLG000012

Comma-separated list of Product SKUs. For a list of acceptable values, see Product Identifier.

SerialNumbers
string
Example: SerialNumbers=1234343434

Comma-separated list of SerialNumbers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adjustment History Invoice Detail Report

The Adjustment History Report endpoint lets you review cost and/or quantity adjustments that have been made to the inventory through the Inventory Adjustment tool in RQ, by adjustment invoice.

Authorizations:
bearerAuth
query Parameters
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.

ReasonCode
required
string
Example: ReasonCode=-1

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

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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

SerialNumber
string
Example: SerialNumber=1234567890

Tracking Number for a RQ Product

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adjustment History Product Detail Report

The Adjustment History Report endpoint will allow you to review cost and/or quantity adjustments that have been made to the inventory through the Inventory Adjustment tools, by product.

Authorizations:
bearerAuth
query Parameters
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.

ReasonCode
required
string
Example: ReasonCode=-1

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

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

For an updated list of acceptable values, see Languages.

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.

LocationType
string
Example: LocationType=Company

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

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

SerialNumber
string
Example: SerialNumber=1234567890

Tracking Number for a RQ Product

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Aged Serialized Inventory Report

The Aged Serialized Inventory Report endpoint allows you to view a list of regular serialized products that have been in stock for longer than desired, based on the configured Days Kept in Stock field in RQ for each serialized product.

Authorizations:
bearerAuth
query Parameters
SearchMethod
required
integer [ 1 .. 5 ]
Example: SearchMethod=1
  • 1: By Location (SearchCriteria2 not required)
  • 2: By Vendor (StoreIDLoggedIn not required)
  • 3: By Location and Vendor
  • 4: By Location and Product SKU
  • 5: By Location and Category

See SearchCriteria2 parameter for corresponding usage.

SearchCriteria2
required
string
Example: SearchCriteria2=5123

The value of this required parameter will depend on the provided SearchMethod:

  • SearchMethod=2|3: Identifier for a Vendor. Use -1 for all Vendors. For a complete list, see Vendor ID.
  • SearchMethod=4: Product SKU. For a list of acceptable Product SKUs, see Product Identifier.
  • SearchMethod=5: Category. For a list of acceptable Categories, see Category Number.
StoreIDLoggedIn
required
string
Example: StoreIDLoggedIn=1

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

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

For an updated list of acceptable values, see Languages.

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.

LocationType
string
Example: LocationType=Company

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auto Ordering Report

The Auto Ordering Report endpoint returns information regarding inventory-ordering for each product as configured in RQ.

Authorizations:
bearerAuth
query Parameters
Search
required
string
Enum: "ByCategory" "ByProductSKU"
Example: Search=ByCategory

Search either by Product Category (use CategoryNumber) or by Product SKU (use ProductIdentifier)

OrderBy
required
string
Enum: "Priority" "LowestCost"
Example: OrderBy=Priority

Order by Priority or by Lowest Cost

VendorID
required
string
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

ProductsToShow
required
integer [ 1 .. 5 ]
Example: ProductsToShow=1
  • 1: Shortages
  • 2: Overages
  • 3: Shortages + Overages
  • 4: All Products
  • 5: All Products with Min/Max
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.

StoreTypeID
string
Example: StoreTypeID=1

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

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auto Transfer In Report

The Auto Transfer In Report endpoint returns information regarding your company's inventory stock balances by identifying stock shortages at specific locations.

Authorizations:
bearerAuth
query Parameters
Type
required
integer [ 1 .. 2 ]
Example: Type=1
  • 1: All Products
  • 2: Ordered Products
ShipToForWho
required
integer [ 1 .. 4 ]
Example: ShipToForWho=1

Identifier for a company tree level to filter on. The ShipToForWhoIDs value then contains identifiers for entities at that level of the tree to filter the report.

  • 1: Company
  • 2: Region
  • 3: District
  • 4: Store
ShipFromForWho
required
integer [ 1 .. 4 ]
Example: ShipFromForWho=1

Identifier for a company tree level to filter on. The ShipFromForWhoIDs value then contains identifiers for entities at that level of the tree to filter the report.

  • 1: Company
  • 2: Region
  • 3: District
  • 4: Store
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

ShipToForWhoIDs
string
Example: ShipToForWhoIDs=-1

Internal identifier for a Store in RQ. For a list of acceptable values, see Location Type ID.

ShipFromForWhoIDs
string
Example: ShipFromForWhoIDs=-1

Comma separated list of identifiers specifying where the transfer was shipped from. For a list of acceptable values, see Location Type ID. To specify all nodes in the tree at the ShipToForWho level, use -1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auto Transfer Out Report

The Auto Transfer Out Report endpoint returns information regarding your company's inventory stock balances by identifying stock shortages at specific locations.

Authorizations:
bearerAuth
query Parameters
Type
required
integer [ 1 .. 2 ]
Example: Type=1
  • 1: All Products
  • 2: Ordered Products
ShipToForWho
required
integer [ 1 .. 4 ]
Example: ShipToForWho=1

Identifier for a company tree level to filter on. The ShipToForWhoIDs value then contains identifiers for entities at that level of the tree to filter the report.

  • 1: Company
  • 2: Region
  • 3: District
  • 4: Store
ShipFromForWho
required
integer [ 1 .. 4 ]
Example: ShipFromForWho=1

Identifier for a company tree level to filter on. The ShipFromForWhoIDs value then contains identifiers for entities at that level of the tree to filter the report.

  • 1: Company
  • 2: Region
  • 3: District
  • 4: Store
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

ShipToForWhoIDs
string
Example: ShipToForWhoIDs=-1

Internal identifier for a Store in RQ. For a list of acceptable values, see Location Type ID.

ShipFromForWhoIDs
string
Example: ShipFromForWhoIDs=-1

Comma separated list of identifiers specifying where the transfer was shipped from. For a list of acceptable values, see Location Type ID. To specify all nodes in the tree at the ShipToForWho level, use -1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consignment History Report

The Consignment History Report endpoint allows you to see what products were on consignment from a certain location and between a specified time frame, as well as what is still out on consignment.

Authorizations:
bearerAuth
query Parameters
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: "ProductDetail" "InvoiceDetail"
Example: ReportType=ProductDetail
  • ProductDetail: ConsignmentHistoryReportData_ProductDetail
  • InvoiceDetail: ConsignmentHistoryReportData_InvoiceDetail

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
[
  • {
    }
]

Count Sheet History Report

The Count Sheet History Report endpoint returns information on created count sheets in RQ for the specified time frame. Count sheets are the recorded result of a physical count done for inventory to ensure what is recorded in RQ matches what is physically in the store.

This endpoint allows you to view the results by invoice, by product, or by products that were not found (see ReportType parameter below for more information).

Authorizations:
bearerAuth
query Parameters
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
integer [ 0 .. 2 ]
Default: 0
Example: ReportType=0
  • 0: ByInvoice (By Invoice)
  • 1: ByProduct (By Product)
  • 2: ByProductNotFound (By Product Not Found)

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

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

SerialNumber
string
Example: SerialNumber=1234567890

Tracking Number for a RQ Product

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
[
  • {
    }
]

Inventory Availability Summary Report

The Inventory Availability Summary Report endpoint allows you to view the availability of a particular product SKU or an entire category of products, at a location or locations of your choosing. This report is useful for referencing your system quantities as compared to your regularly scheduled inventory counts.

Authorizations:
bearerAuth
query Parameters
SearchType
required
integer [ 1 .. 2 ]
Example: SearchType=1
  • 1: Summarize by Category (use CategoryNumber)
  • 2: Summarize by Product (use ProductIdentifier)
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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory Listing Report

The Inventory Listing Report endpoint allows you to view a complete list of products, including inventory information, for a given LocationTypeID (will default to whole company).

Authorizations:
bearerAuth
query Parameters
BinStatus
required
integer [ 1 .. 10 ]
Example: BinStatus=1

Product Status

  • 1: In Stock
  • 2: On RMA
  • 3: Transfer In
  • 4: Transfer Out
  • 5: On Loan
  • 6: Non-Sellable
  • 7: On Order
  • 8: On Back Order
  • 9: Total Inventory - Purchased
  • 10: Any Status
QtyStatus
required
integer [ 1 .. 5 ]
Example: QtyStatus=1

Quantity Status

  • 1: With - Qty
  • 2: With + Qty
  • 3: With 0 Qty
  • 4: With Any Qty
  • 5: With non-zero Qty
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.

BlindInventory
boolean
Default: false
Example: BlindInventory=false

A flag to indicate if the report will include product quantities (false) or product details only per location (true)

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Non Sellable History Report

The Non-Sellable History Report endpoint returns historical information for products marked as "Non-Sellable" in RQ.

Authorizations:
bearerAuth
query Parameters
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.

ReasonCode
required
string <guid>
Example: ReasonCode=fa1f1eb1-b98e-4dcf-aa2c-786963ccc310

Internal identifier for an Non-Sellable Reason Code. For a complete list, see Non-Sellable Reason Code.

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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Non Sellable Products Report

The Non-Sellable Products Report endpoint returns a list of all items currently in the Non-Sellable state in RQ.

Authorizations:
bearerAuth
query Parameters
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 <guid>
Example: ReasonCode=fa1f1eb1-b98e-4dcf-aa2c-786963ccc310

Internal identifier for an Non-Sellable Reason Code. Defaults to all reason codes if not provided. For a complete list, see Non-Sellable Reason Code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Over Receiving Inventory Report

The Over Receiving Inventory Report returns inventory information per location where the quantity received is more than the quantity ordered, or over-received.

Authorizations:
bearerAuth
query Parameters
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.

PurchaseOrderID
required
integer
Example: PurchaseOrderID=17388

Internal identifier for a Purchase Order in RQ. To search all purchase orders, use -1 and omit PurchaseOrderIDByStore.

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.

PurchaseOrderIDByStore
string
Example: PurchaseOrderIDByStore=84WEAPO1039

Identifier for a Purchase Order in RQ. For all purchase orders, omit this property and use PurchaseOrderID=-1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
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
[
  • {
    }
]

Product Tracking Report

The Product Tracking Report endpoint returns historical and tracking information for the provided SerialNumber as recorded in RQ.

For non-serialized products, the information returned is aggregated per transaction instead.

Authorizations:
bearerAuth
query Parameters
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.

SerialNumber
string
Example: SerialNumber=1234567890

Serial Number. For this specific endpoint, one of either ProductIdentifier or SerialNumber, or both must be included

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

Product SKU. For this specific endpoint, one of either ProductIdentifier or SerialNumber, or both must be included.

For a list of acceptable values, see Product Identifier.

AllowPartialMatches
boolean
Example: AllowPartialMatches=false

A flag to indicate if the search should include partial matches (True) or exact matches (False). If both parameters SerialNumber & ProductIdentifier are included, this parameter must be included.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products Committed On Sales Orders Report

The Products Committed on Sales Order Report endpoint returns a list of all Sales Orders in your database that remain open and has a product committed inside the order.

Authorizations:
bearerAuth
query Parameters
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 .. 3 ]
Example: SearchMethod=1
  • 1: General search
  • 2: Search by TransferIDByStore, this parameter becomes required.
  • 3: Search by ReceivingIDByStore, this parameter becomes required.
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.

TransferIDByStore
string
Example: TransferIDByStore=TARGETR1

Identifier for a Transfer in RQ.

ReceivingIDByStore
string
Example: ReceivingIDByStore=84WEARE1044

Identifier for a received Transfer in RQ.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products Life Cycle By Serial Numbers

This endpoint returns information regarding the life cycle of the products with the provided serial numbers.

Authorizations:
bearerAuth
query Parameters
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

SerialNumbers
string
Example: SerialNumbers=1234343434

Comma-separated list of SerialNumbers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purchase History Report

The Purchase History Report endpoint allows you to view all items ordered and received based on specific search criteria

Authorizations:
bearerAuth
query Parameters
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 [ 1 .. 2 ]
Example: Filter=1
  • 1: All Purchase Orders
  • 2: Filter to only include Ordered Purchase Orders
SearchMethod
required
integer [ 1 .. 3 ]
Example: SearchMethod=1
  • 1: Search by Category (CategoryNumber is required)
  • 2: Search by Product (ProductIdentifier is required)
  • 3: search by Vendor (VendorID is required)
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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

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

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

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
[
  • {
    }
]

Purchase Orders

The Purchase Orders endpoint returns summarized information for all Purchase Orders in RQ based on the provided criteria.

Authorizations:
bearerAuth
query Parameters
Committed
required
integer [ -1 .. 1 ]
Example: Committed=-1
  • -1: Filter to only show Committed Purchase Orders (POs)
  • 0: Filter to only show Non-committed POs
  • 1: Filter to show all POs
AlsoSearchByESN
required
boolean
Example: AlsoSearchByESN=false

A flag to indicate if SearchTerm should also search for a PO by ESN or not.

SearchTerm
string
Example: SearchTerm=52POGG18737

Value to search for a PO by. Searches the following properties:

  • PO No. (PurchaseOrderIdByStore)
  • Reference Number
  • Vendor No. (VendorInvoiceNumber)
VendorID
string
Default: "-1"
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

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
[
  • {
    }
]

Purchase Order Detail Report

The Purchase Order Detail endpoint returns comprehensive information for all Purchase Orders in RQ based on the provided criteria.

Authorizations:
bearerAuth
query Parameters
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.

VendorID
required
string
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

FilterBy
required
integer [ 0 .. 3 ]
Example: FilterBy=0
  • 0: Show all Purchase Orders (POs)
  • 1: Filter to Partially Received
  • 2: Filter to Fully Received
  • 3: Filter to Outstanding (nothing received)
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
[
  • {
    }
]

Receiving Invoice History By Invoice Report

The Receiving Invoice History By Invoice Report endpoint returns historical information on receiving invoices summarized by the ReceivingID and ReceivingIDByStore (aka Receiving Invoice in RQ). This is used to compare the total dollar value received into RQ with the total dollar value in your A/P account.

Authorizations:
bearerAuth
query Parameters
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.

VendorID
required
string
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Receiving Invoice History By Product Report

The Receiving Invoice History By Invoice Report endpoint returns historical information on receiving invoices summarized by the received products. You can compare the total dollar value received into RQ with the total dollar value in your A/P account.

Authorizations:
bearerAuth
query Parameters
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.

VendorID
required
string
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

RMA History Invoice Report

The RMA History Invoice Report endpoint returns a complete audit trail of recorded RMAs that have been reconciled summarized per RMA invoice.

Authorizations:
bearerAuth
query Parameters
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.

VendorID
required
string
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

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
[
  • {
    }
]

RMA History Product Report

The RMA History Invoice Report endpoint returns a complete audit trail of recorded RMAs that have been reconciled summarized per product.

Authorizations:
bearerAuth
query Parameters
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.

VendorID
required
string
Example: VendorID=-1

Internal identifier for a Vendor in RQ. Use -1 for all Vendors. For a complete list, see Vendor ID.

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
[
  • {
    }
]

Term Details Report

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

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Transfer History Invoice Detail Report

The Transfer History Report endpoint returns historical information for all products that were recorded to be transferred from one location to another inside RQ, summarized per Transfer Invoice.

Authorizations:
bearerAuth
query Parameters
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.

ShippedForWho
required
string
Example: ShippedForWho=1

Identifier for a level at which the transfer originated from.

ReceivedForWho
required
string
Example: ReceivedForWho=Company

Identifier for a level at which the transfer was sent.

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

For an updated list of acceptable values, see Languages.

ShippedForWhoIDs
string
Example: ShippedForWhoIDs=-1

A comma separated list of identifiers to specify where the transfer originated from. To ignore this and specify All nodes, use -1.

ReceivedForWhoIDs
string
Example: ReceivedForWhoIDs=-1

A comma separated list of identifiers to specify where the transfer was sent. To ignore this and specify All nodes, use -1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transfer History Product Detail

The Transfer History Report endpoint returns historical information for all products that were recorded to be transferred from one location to another inside RQ, summarized per product.

Authorizations:
bearerAuth
query Parameters
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.

ShippedForWho
required
string
Example: ShippedForWho=1

Identifier for a level at which the transfer originated from.

ReceivedForWho
required
string
Example: ReceivedForWho=Company

Identifier for a level at which the transfer was sent.

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

For an updated list of acceptable values, see Languages.

ShippedForWhoIDs
string
Example: ShippedForWhoIDs=-1

A comma separated list of identifiers to specify where the transfer originated from. To ignore this and specify All nodes, use -1.

ReceivedForWhoIDs
string
Example: ReceivedForWhoIDs=-1

A comma separated list of identifiers to specify where the transfer was sent. To ignore this and specify All nodes, use -1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transfers

The Transfers endpoint provides a summarized view of any outstanding transfers, in either committed and non-committed status. This report mimics the Transfers Module in RQ's Inventory console. This endpoint excludes transfers that were cancelled, deleted or completed.

Authorizations:
bearerAuth
query Parameters
DateAsOf
required
string <date>
Example: DateAsOf=2020-01-01

Date at which to begin search

Committed
required
integer [ -1 .. 1 ]
Example: Committed=-1

A flag to indicate of the results should be filtered to Committed (1) Non-committed (0) or All (-1).

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.

SearchTerm
string
Example: SearchTerm=TARGETR1

Value to search for a Transfer by. Searches the TransferIDByStore property.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Library Mapping Discrepancy

This endpoint returns a list of all discrepancies found between all recorded Products in RQ and Products in the Product Library.

Authorizations:
bearerAuth
query Parameters
LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For an updated list of acceptable values, see Languages.

ManufacturerID
integer
Default: -1
Example: ManufacturerID=1

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Warranty Inventory Listing Report

The Warranty Loaner Inventory Listing Report endpoint provides a detailed list all your Warranty Loaner products as recorded in RQ.

Authorizations:
bearerAuth
query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Employees Detailed List

This endpoint returns a detailed list of all Employees as configured in RQ. You can use the described Query Parameters below to refine your search.

Authorizations:
bearerAuth
query Parameters
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.

UserManagerEmployeeID
integer
Example: UserManagerEmployeeID=2356448

Internal identifier for an Employee in the iQmetrix User Manager API. For a list of acceptable values, see Employees.

EmployeeID
integer
Example: EmployeeID=12345

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

EmployeeName
string
Example: EmployeeName=John Smith

Name of the employee

Phone
string
Example: Phone=5555555555

Work phone of the employee

Email
string
Example: Email=test@test.com

Email of the employee

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

Unique identifier of a thumbprint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee Assigned Locations

The Employee Assigned Location endpoint returns a list of Assigned Locations for the provided EmployeeID or UserManagerEmployeeID as configured in RQ.

Authorizations:
bearerAuth
query Parameters
EmployeeID
integer
Example: EmployeeID=12345

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

UserManagerEmployeeID
integer
Example: UserManagerEmployeeID=2356448

Identifier for the employee in the iQmetrix User Manager API. Either this value or EmployeeID is required. For a list of acceptable values, see Employees.

LocationEnabled
boolean
Default: true
Example: LocationEnabled=true

Filter for enabled locations (true) or disabled locations (false).

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
[
  • {
    }
]

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

The Employee Payroll Report endpoint shows all scheduled, regular clocked, and overtime clocked hours worked by a specific employee/s during a specific time frame and at a specified location/s.

Authorizations:
bearerAuth
query Parameters
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.

OrderBy
string
Enum: "ByStores" "ByEmployees"
Example: OrderBy=ByEmployees

Order the response either by Stores or by Employees.

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
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
[
  • {
    }
]

Location Payroll Report

The Location Payroll Report endpoint shows all scheduled, regular clocked, and overtime clocked hours worked at a specific location during a specific time frame

Authorizations:
bearerAuth
query Parameters
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.

OrderBy
required
string
Enum: "ByStores" "ByEmployees"
Example: OrderBy=ByEmployees

Order the response either by Stores or by Employees.

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
[
  • {
    }
]

Login Audit Report

The Login Audit Report endpoint provides detailed information for employee logins. There are three different views available, set by the ReportType parameter:

  • Login Details: the details of every employee login that occurred during the search date range and scope
  • Last Logins: the most recent login of each employee who logged in during the search date range and scope
  • No Logins: each employee who did not login during the search date range and scope (NOTE: in the API response the "LoginDate" will always return 'NULL' in this section, and in the RQ Client the 'Last Login' will always show 'Never' in this tab)
Authorizations:
bearerAuth
query Parameters
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: "All" "Details" "LastLogins" "NoLogins"
Example: ReportType=All
  • Details: LoginAuditReportDetailsData
  • LastLogins: LoginAuditReportDetailsData
  • NoLogins: LoginAuditReportData
  • All: LoginAuditReportAllData

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
[
  • {
    }
]

Time And Attendance Report

The Time And Attendance Report endpoint lets you review all details relating to scheduled and actual time and attendance for employees.

Authorizations:
bearerAuth
query Parameters
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.

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 Attendance Details

The Employee Attendance Details report allows you to view detailed information regarding a specific employee's punched shift for a day.

Authorizations:
bearerAuth
query Parameters
EmployeeID
required
integer
Example: EmployeeID=12345

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

SearchDate
required
string <date>
Example: SearchDate=2020-01-01

Date of the search period

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
[
  • {
    }
]

Punch Revision Details

The Punch Revision Details report allows you to view detailed information regarding a specific employee's revised punches for a day.

Authorizations:
bearerAuth
query Parameters
EmployeeID
required
integer
Example: EmployeeID=12345

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

SearchDate
required
string <date>
Example: SearchDate=2020-01-01

Date of the search period

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance

A/R Ledger Activity Report

The A/R Ledger Activity Report endpoint returns a list of all transactions that have affected your customer's Account Receivable account

Authorizations:
bearerAuth
query Parameters
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.

ActivityType
required
integer [ 0 .. 2 ]
Example: ActivityType=0
  • 0: All activity types
  • 1: Invoice/Refunds
  • 2: Payments
SearchMethod
required
integer [ 1 .. 2 ]
Example: SearchMethod=1
  • 1: By Location (LocationTypeIDs is required)
  • 2: By Account (AccountsReceivableIDByStore is required)
AccountsReceivableIDByStore
string
Example: AccountsReceivableIDByStore=12212AR1

RQ-generated customer account number

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.

LocationType
string
Example: LocationType=Company

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

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
[
  • {
    }
]

Bill Pay History Report

The Bill Pay History Report endpoint returns information for all Bill Pay transactions recorded during the specified time frame.

Authorizations:
bearerAuth
query Parameters
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.

ProviderID
required
integer
Example: ProviderID=1

For a list of acceptable values, see Bill Pay Provider ID. Use -1 for all Providers

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
[
  • {
    }
]

Cash Audit Trail Report

The Cash Audit Trail Report endpoint provides a detailed running list of all transactions through a selected number of terminals. All information regarding Cash-Ins, Drawer Audits, Skims and transactions is returned by this endpoint.

Authorizations:
bearerAuth
query Parameters
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.

TypeID
required
integer
Example: TypeID=-1

Filter based on the type of Cash Audit Trail transaction. -1 for all transaction types. For a list of acceptable values, see Cash Audit Trail Type ID.

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

For an updated list of acceptable values, see Languages.

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.

LocationType
string
Example: LocationType=Company

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

TerminalIDs
string
Example: TerminalIDs=1

Comma separated list of Terminal identifiers. Leave blank for All Terminals

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

This parameter enables you to filter by a cashout's updated date. As cashouts in RQ can be updated and reconciled, this feature lets you filter cashouts that were only updated between the CashoutRowUpdatedStartDate and CashoutRowUpdatedStopDate

Note: this feature requires the parameter TypeID=4 and RQ database of 6.29 and up to work.

CashoutRowUpdatedStopDate
string <date>
Example: CashoutRowUpdatedStopDate=2019-06-03

End date of the period to search for a cashout's updated date. See CashoutRowUpdatedStartDate description above for more information.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cash Outs

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

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Cash Out Summary Report

The Cashout Summary Report endpoint lets you review all aspects of recorded cashouts including which employees are cashing out, differences, which cashouts need to be reconciled, etc.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Charge Back Summary Report

The Charge Back Summary Report endpoint helps you identify when, and which, full charge backs have been committed in your database. It lets you observe the breakdown from Location Summary all the way to Employee and Product Summaries.

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

Filter report by invoices created after this date

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

Filter report by invoices created before this date

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

Filter report by charge backs created after this date

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

Filter report by charge backs created before this date

QueryPart
required
integer [ 1 .. 6 ]
Example: QueryPart=1
  • 1: ChargeBackSummaryReportLocationData (Location Summary)
  • 2: ChargeBackSummaryReportCategoryData (Category Summary)
  • 3: ChargeBackSummaryReportProductSummaryData (Product Summary)
  • 4: ChargeBackSummaryReportProductDetailData (Product Detail)
  • 5: ChargeBackSummaryReportEmployeeData (Employee Summary)
  • 6: ChargeBackSummaryReportHardwareCollectionData (Hardware)

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

SearchMethod
required
integer [ 1 .. 3 ]
Example: SearchMethod=1
  • 1: Category (use CategoryNumber)
  • 2: Product (use ProductIdentifier)
  • 3: Journal Number (use JournalIDs)
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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

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

Filter report by Journal. Use -1 for All Journals.

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.

LocationType
string
Example: LocationType=Company

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gift Card Summary Report

The Gift Card Summary Report endpoint allows you to quickly view the details surrounding the sales and redemption of Gift Cards within your company

Authorizations:
bearerAuth
query Parameters
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" "Summary" "Detail" "EmployeeSummary"
Example: ReportType=DailySummary
  • DailySummary: DailySummaryData
  • LocationSummary: LocationSummaryData
  • Summary: SummaryData
  • Detail: DetailData
  • EmployeeSummary: EmployeeSummaryData

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

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.

LocationType
string
Example: LocationType=Company

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

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

G/L Account Activity Report

The G/L Account Activity Report endpoint allows you to review what is happening with your general ledger accounts for a location, region, etc.

Authorizations:
bearerAuth
query Parameters
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.

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
[
  • {
    }
]

G/L Account Activity - Company Detail

The Company Detail Inquiry Report endpoint lists all transaction for the entire company between the date range indicated.

Authorizations:
bearerAuth
query Parameters
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.

AccountID
required
string
Example: AccountID=-1

Internal identifier for an Account Number in RQ. Use -1 for all accounts.

LocationType
string
Example: LocationType=Company

If StoreID is not specified, filters based on the Location Tree. For a list of acceptable values, see Location Type.

LocationTypeIDs
string
Example: LocationTypeIDs=-1

If StoreID is not specified, filters based on the IDs within the LocationType. For a list of acceptable values, see Location Type ID.

StoreID
string
Example: StoreID=124

If LocationType/LocationTypeID is not specified, Store ID based on the Location Tree. For a list of acceptable values, see Stores.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

G/L Account Activity - Great Plains

This endpoint returns G/L Account Activity information meant for exporting to Great Plains accounting software.

Authorizations:
bearerAuth
query Parameters
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.

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
[
  • {
    }
]

G/L Account Activity - QuickBooks

This endpoint returns G/L Account Activity information meant for exporting to QuickBooks accounting software.

Authorizations:
bearerAuth
query Parameters
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.

ExcludeTransfers
required
boolean
Example: ExcludeTransfers=false

A flag to indicate if the report should include Transfers (false) or not (true)

PONumType
required
integer [ 0 .. 2 ]
Example: PONumType=0
  • 0: Receive
  • 1: Vendor Invoice Number
  • 2: Purchase Order Number
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
[
  • {
    }
]

G/L Account List Report

The G/L Account List Report endpoint returns your general ledger accounts list

Authorizations:
bearerAuth
query Parameters
EnabledStatus
required
integer [ 0 .. 2 ]
Example: EnabledStatus=0
  • 0: Disabled
  • 1: Enabled
  • 2: Any
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tax Collected Report

The Tax Collected Report endpoint returns a summary of tax amounts collected, taxable sales, and non-taxable sales for each tax for the provided location/s.

Some tax considerations:

  • Taxable sales are calculated using either the list price or the selling price of the taxed products, depending on how the tax was set up. Non-taxable sales are always based on the selling price.
  • Due to the fact that taxable sales are based on list price, the Gross Sales may not equal the Sales for the location.
  • Due to differences regarding to whom the Bill Pay tax should be paid, Bill Pay transaction taxes are not included in the returned response.
  • Discrepancies found between Gross Charges and Sales can be attributed to Bill Payments.
  • Vendor rebate amounts may or may not be included, depending on applicable sales tax regulations.
Authorizations:
bearerAuth
query Parameters
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: "Sales" "ExtraCharges" "Coupons" "NetSales"
Example: ReportType=Sales
  • Sales: TaxCollectedReport_SalesData
  • ExtraCharges: TaxCollectedReport_ExtraChargesData
  • Coupons: TaxCollectedReport_CouponsData
  • NetSales: TaxCollectedReport_NetSalesData

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.

IncludeVendorRebates
boolean
Default: false
Example: IncludeVendorRebates=false

A flag to indicate if Vendor Rebates should be included in results (True) or not (False).

TaxIDs
integer
Example: TaxIDs=-1

Comma separated list of Tax identifiers in RQ. Use -1 to specify All Taxes. For a list of acceptable values, see Tax ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payment Integration Transaction By Date Report

The Payment Integration Transaction By Date Report endpoint allows you to view all payment integration transactions in a selected time period for selected locations, districts, regions or the whole company.

Authorizations:
bearerAuth
query Parameters
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.

LocationEntityIDs
integer
Example: LocationEntityIDs=664321

Comma separated list of identifiers for Locations in the Entity Store API. For a list of acceptable values, see Location Type ID endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payment Type Audit Report

The Payment Type Audit Report endpoint provides a running list of all transaction types and what payment type each was tendered with.

Authorizations:
bearerAuth
query Parameters
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.

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.

LocationType
string
Example: LocationType=Company

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tax Details Report

The Tax Details Report endpoint provides a comprehensive look at your recorded taxable sales.

Some tax considerations:

  • Taxable sales are calculated using either the list price or the selling price of the taxed products, depending on how the tax was set up.
  • Non-taxable sales are always based on the selling price.
  • Due to the fact that taxable sales are based on list price, the Gross Sales may not equal the Sales for the location
  • The returned response includes the VendorRebatesTax field which can help you quickly check if your vendor rebates are being taxed, or not taxed, properly.
  • This endpoint returns all applicable taxes for the transaction as additional field/s
Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Tax Details Non Taxable Sales By Bill Pay

This endpoint returns Tax Details report information filtered for Non Taxable Sales by Bill Pay.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Tax Details Non Taxable Sales By Invoice Id

This endpoint returns Tax Details report information filtered for Non Taxable Sales by InvoiceIDByStore.

Authorizations:
bearerAuth
query Parameters
InvoiceIDByStore
required
string
Example: InvoiceIDByStore=52POGG18737

Invoice ID generated and as seen in RQ

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
[
  • {
    }
]

Tax Details Non Taxable Sales By Invoices

This endpoint returns Tax Details report information filtered for Non Taxable Sales by Invoices.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Tax Details Non Taxable Sales By Products

This endpoint returns Tax Details report information filtered for Non Taxable Sales by Products.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Tax Details Taxable Sales By Bill Pay

This endpoint returns Tax Details report information filtered for Taxable Sales by Bill Pay.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Tax Details Taxable Sales By Invoice Id

This endpoint returns Tax Details report information filtered for Taxable Sales by InvoiceIDByStore.

Authorizations:
bearerAuth
query Parameters
InvoiceIDByStore
required
string
Example: InvoiceIDByStore=52POGG18737

Invoice ID generated and as seen in RQ

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
[
  • {
    }
]

Tax Details Taxable Sales By Invoices

This endpoint returns Tax Details report information filtered for Taxable Sales by Invoices.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Tax Details Taxable Sales By Products

This endpoint returns Tax Details report information filtered for Taxable Sales by Products.

Authorizations:
bearerAuth
query Parameters
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.

GroupDropshipProducts
boolean
Default: true
Example: GroupDropshipProducts=true

When GroupDropshipProducts=True the products in the returned response will be grouped by RQ Product SKU only (default behaviour). When GroupDropshipProducts=False the products in the returned response will be additionally grouped by the Product Library Name to align with what is shown on the RQ Sales Invoice.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Commission

Commission Ledger Activity Report

The Commission Ledger Activity Report endpoint gives you a comprehensive overview of commission activity for an employee, a location, a region, a district, or the entire company. For filtering, use the parameters 'LocationType' and 'LocationTypeIDs'. Note: The parameter 'EmployeeID' is ignored when the token is admin, otherwise is used to filter-out unpermitted locations for that employee's role.

Authorizations:
bearerAuth
query Parameters
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.

TransactionType
required
integer [ 0 .. 6 ]
Example: TransactionType=1
  • 0: All
  • 1: Invoice
  • 2: Manual
  • 3: Reversal
  • 4: Vendor Rebate Adjustment
  • 5: Coupon
  • 6: Full Charge Back
ReconcStatus
required
integer [ -1 .. 5 ]
Example: ReconcStatus=-1

Reconciled status.

  • -1: All commissionable products
  • 0: Commissions on products that have not been reconciled as part of the vendor rebate or charge back reconciliation process (Non-Reconciled)
  • 1: Commissions on products that have been reconciled as part of the vendor rebate or charge back reconciliation process (Reconciled)
  • 2: Commissions on products in a specific Vendor Account Journal, does not include any product that cannot be reconciled (Journal)
  • 3: Commissions on products that have been reconciled as part of the vendor rebate or charge back reconciliation process plus products that cannot be reconciled, i.e. non-vendor-rebate products (Reconciled + Reconciliation-exempt Items)
  • 4: Commissions on products in a specific Vendor Account Journal plus products that cannot be reconciled, i.e. non-vendor-rebate products (Journal + Reconciliation-exempt Items)
  • 5: Products that cannot be reconciled, i.e. non vendor rebate products (Reconciliation-exempt Items)
JournalIDs
required
string
Example: JournalIDs=-1

Filter report by Journal. Use -1 for All Journals.

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.

ProductIdentifier
string
Example: ProductIdentifier=ACPHLG000135

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
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
[
  • {
    }
]

Vendor Deposit History Report

The Vendor Deposit History Report endpoint lets you view any or all vendor deposits or refunds. With this API endpoint, you can view vendor deposits/refunds created in a certain time period and/or those that are still outstanding. This endpoint also provides an audit trail that you can retrieve for any vendor deposit from any date, regardless of its reconciled status.

Authorizations:
bearerAuth
query Parameters
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.

VendorAccountID
required
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.

Reconciled
required
string
Example: Reconciled=-1

Use -1 to list all

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.

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

Filter report by Journal. Use -1 for All Journals.

EmployeeID
integer
Example: EmployeeID=12345

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Vendor Rebate Reconciliation Adjustment History

The Vendor Rebate Reconciliation Adjustment History Report endpoint lets you review the vendor rebates that have been adjusted as part of the reconciliation process.

Authorizations:
bearerAuth
query Parameters
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: "ProductDetail" "InvoiceDetail"
Example: ReportType=ProductDetail
  • ProductDetail: VendorRebateReconciliationAdjustmentHistoryReport_ProductDetail
  • InvoiceDetail: VendorRebateReconciliationAdjustmentHistoryReport_InvoiceDetail

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
[
  • {
    }
]

Misc

Protection Plan History Report

The Protection Plan History Report endpoint returns a list of all transactions associated with a Protection Plan.

Authorizations:
bearerAuth
query Parameters
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.

ProviderName
string
Example: ProviderName=Test provider

Name of the provider

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Repair Report

The Repair Report endpoint allows you to view repairs by date, location, device, and status of all Repairs as recorded in RQ.

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Request Type Details Report

The Service Request Type Details Report endpoint provides access to the details of repairs by device.

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.

TemplateIDs
string <guid>
Example: TemplateIDs=1b861d24-156e-497e-a81a-0011893a7c51

Template IDs from Repair Report

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Trade-In Activity Report

The Trade-In Activity Report endpoint allows you to view all trade-in transactions that satisfies the provided parameters.

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

Identifier for your company.

ProviderID
required
integer
Example: ProviderID=10

Identifier for a trade-in provider in RQ. For a list of acceptable values, see Trade-In Provider ID.

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, this parameter will filter based on the Location Tree. For a list of acceptable values, see Location Type.

Note: If using this parameter, this must be used in conjunction with the LocationTypeIDs parameter to get the most accurate results.

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

When provided, this parameter 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.

Note: If using this parameter, this must be used in conjunction with the LocationType parameter to get the most accurate results.

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.

SerialNumbers
string
Example: SerialNumbers=1234343434

Comma-separated list of SerialNumbers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attributes

Attachment Rates

Returns a list of Attachment Rates as configured in RQ.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Customer Relationships

This endpoint can be used to retrieve a list of relationships between customers in RQ.

Authorizations:
bearerAuth
query Parameters
ChildCustomerID
integer
Example: ChildCustomerID=1002

Internal identifier for a customer in RQ.

ParentCustomerID
integer
Example: ParentCustomerID=1

Internal identifier for a customer in RQ.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Date Range

For requests that include parameters of StartDate & StopDate, the parameter of DateRange 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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Languages

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

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Identifiers

Activity Type ID

Returns a list of Customer Activity Types as configured in RQ.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bill Pay Provider ID

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

Authorizations:
bearerAuth
query Parameters
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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Coupon ID

Returns a list of Coupons as configured in RQ.

Authorizations:
bearerAuth
query Parameters
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
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
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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Integration Provider ID

Returns a pre-configured list of available Integration Providers.

Authorizations:
bearerAuth

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

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
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
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
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
[
  • {
    }
]

Inventory Adjustment Reason Code

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

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tax ID

Returns a list of Taxes as configured in RQ.

Authorizations:
bearerAuth
query Parameters
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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Vendor Account ID

Returns a list of all Vendor Accounts.

Authorizations:
bearerAuth

Responses

Response samples

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

Vendor ID

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

Authorizations:
bearerAuth
query Parameters
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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entry Types

Returns a pre-configured list of Payment Entry types.

Authorizations:
bearerAuth
query Parameters
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

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product Type

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

Authorizations:
bearerAuth

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
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
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
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
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
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
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
Status
integer
Enum: 0 1 4
Example: Status=1
  • 0: Disabled
  • 1: Enabled
  • 4: Hidden
GroupDefinitionID
integer
Example: GroupDefinitionID=15

ID of the Group Definition

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Security Roles

Returns a list of Security Roles as configured in RQ.

Authorizations:
bearerAuth
query Parameters
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
[
  • {
    }
]

Entities

Carriers

Returns a pre-configured list of Carriers.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Returns a summarized list of Employees as configured in RQ.

Authorizations:
bearerAuth
query Parameters
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
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
[
  • {
    }
]