Changelog

All non-breaking changes, developer portal upgrades and fixes are communicated through this changelog weekly. If there are no significant changes, there will be no entry in this log for that week.

Jul 14, 2021

What’s New

Vendor Inventory Services (VIS) Guide

Guide has been updated with the new Transfers endpoints.

What’s Changed

Non-functional star ratings have been removed.
Revised parameter descriptions of the DataConnect endpoint Trade-In Activity Report.

Jul 07, 2021

What’s Changed

Revised response status descriptions to be more inline with the accepted HTTP Status Codes.

What’s New

Vendor Inventory Services (VIS)

New field quantityNonSellable added to Inventory Report endpoint.
New endpoints added:

Jun 23, 2021

What’s Changed

Revised description of bearerAuth authentication scheme for all API pages.

Sales Order

Revised description of the following fields in the Sales Order schema:
- Items
- Items[].LineNumber
- Items[].CorrelationId

Jun 09, 2021

What’s Changed

Vendor Inventory Services (VIS) Guide

Revised the Step 2 - Send Products to iQmetrix step for clarity.

Curation

Revised the Request Body Schema of Add a Product to a Product Feed endpoint for accuracy.

User Manager

Added tag/section groupings for clarity.

May 26, 2021

What’s New

Vendor Inventory Services (VIS)

Guide has been updated to reflect the new Shipping Notices and RMA flow.

User Manager

New endpoint documented: Get All Users Assigned to a Security Role.

May 12, 2021

What’s Changed

Vendor Inventory Services (VIS)

New endpoints added:
Updated request body schema for Create a Purchase Order
Updated top-level title to reflect service branding
Revised tag groupings

May 05, 2021

What’s Changed

Accounts

Improved description of Obtaining an Access Token endpoint

Apr 21, 2021

What’s Changed

Customers/CRM

Re-arranged/renamed headings for better clarity

Apr 14, 2021

What’s Changed

Made corrections to some intra-site links in some API pages that were not linking to the proper endpoints

DataConnect

Improved top-level description
Streamlined endpoint-specific URLs
Improved to query parameter ordering for some endpoints where it makes sense
Added new Usage section to expand on DataConnect’s universal functionalities and overhauled existing documentation related to this including:
- Expanded universal query parameters
- Added error messages and descriptions
- Created new sample endpoints that encapsulates all of these universal functionalities
Removed redundant response field descriptions
Revised grouping of endpoints
Improved description of additional property taxName and paymentMethodName
Corrected intra-site links to other API pages

Shipping Options

Added some in-page links
Minor revision of top-level description

Dropship

Improved top-level page description
Revised tags and tag groupings and added descriptions
Added Webhook Events documentation
Revised endpoint summary and links
Improved endpoint descriptions
Revised endpoint ordering (to adhere to CRUD)
Improved response field descriptions

Mar 10, 2021

What’s Changed

Catalog

Improved descriptions of endpoints, sections, and fields
Corrected invalid site links

Mar 03, 2021

What’s Changed

Made corrections to Markdown links within the API pages that are incorrectly linked
Added missing response fields/information that were detected by new tests
Made corrections to endpoint section links that are inconsistent with the endpoint’s summary

Feb 24, 2021

What’s Changed

Pricing

Refactored descriptions for endpoints, parameters, and response fields
Added/Moved around descriptions to tags/sections
Added links throughout the page
Tested, verified, and made changes where necessary for the response/request body schemas
Modified variable names for consistency
Modified example values for consistency
Added default values where applicable

User Manager

Corrected schemas with missing properties
Improved/reworked top-level, endpoint, schema fields, and parameters descriptions
Added descriptions to each section/tag
Consolidated endpoint grouping
Removed redundant and/or implicit verbiage
Added default values where applicable
Improved example values for more consistency throughout the page

Inventory Availability

Improved top-level description
Removed references to other entities beside entities with Location role to clarify usage
Improved endpoint descriptions
Improved endpoint grouping
Improved sectioning and added section descriptions
Improved examples’ consistency throughout the document
Improved/added descriptions of response/request body fields
Removed “Supplier Availability” section and relocated to a new page

What’s New

Supplier Availability

The endpoints listed in this page were moved from the Supplier Availability section in the Inventory Availability section, citing usage differences significant enough to warrant a new, separate page.

Feb 17, 2021

What’s Changed

Entities

Updated top-level description
Improved examples’ consistency
Added descriptions to and improved existing descriptions of endpoints
Validated schemas
Corrected misspellings and removed grammatical and functional redundancies

Orders

Improved descriptions of endpoint, parameters, and response/request objects
Added missing examples
Improved ordering of Tags and endpoints
Improved wording of Summaries
Added missing PUT endpoint Update Item for an Order for Items

Sales Order

Added new endpoint Get all Sales Orders associated with a PrintableId
Improved endpoint descriptions
Improved schema fields descriptions
Moved less visible descriptions to a more visible space

Purchase Orders

Improved endpoint descriptions
Improved descriptions of response fields

Transaction Details

Improved/added endpoint descriptions
Corrected misspellings

Curation

Improved top-level description
Re-arranged endpoint ordering
Improved endpoint, response/request body descriptions
Improved examples for consistency

Product Subscriptions

Corrected SubscriptionListId to ListId to respect the returned data
Moved security description to a more logical space
Improved endpoint, response/request body descriptions

Supplier Cost

Improved endpoint description
Improved parameter descriptions
Moved less visible descriptions to a more visible space
Improved consistency of examples

Vendor Services

Improved endpoint descriptions
Standardized summary and operation-id
Improved response/request body descriptions
Improved example consistency
Corrected misspellings
Updated the links in the linked guide

Jan 19, 2021

What’s Changed

DataConnect and DataConnect for Partners

improved and standardized endpoint descriptions

Accounts / Authorization Page

Improved wording for some of descriptions
Moved less visible descriptions to a more visible space

Catalog

Improved wording for some of descriptions
Filled in missing descriptions and examples

Customers/CRM

Overhauled top level document description
Verified some and removed non-functional documented functionalities
Moved less visible descriptions to a more visible space
Improved wording for some of descriptions and removed implicit information stated explicitly

Jan 12, 2021

What’s Changed

DataConnect

Changes applied from additional unit tests against the documents which includes the following improvements:

added examples/descriptions to response fields with no examples/descriptions
corrected various query parameters listed as required but not actually required
improved descriptions of response fields and query parameters
corrected found misspellings

Curation/Product Feed

Changes applied from additional unit tests against the documents which includes the following improvements:

added examples/descriptions to response fields with no examples/descriptions
improved descriptions of response fields and query parameters
corrected found misspellings
corrected incorrect data types
updated some examples to be more relevant

Sales Order

Updated some description to remove implicit information and move around pertinent information to a more visible space
Added new response property/field SourceTag to the Sales Order schema
Updated example of the Get Log Entries for a Sales Order endpoint

Customers

Removed Id field of the request bodies of the following POST endpoints, as this field is only relevant for PUT calls:

Pricing

Updated description of Get All Entity-Level Pricing Information

Nov 25, 2020

What’s Changed

DataConnect

updated formatting for query parameters with enumerables
added back mistakenly-removed information from last week’s deploy
updated required and optional query parameters from testing

Nov 18, 2020

What’s Changed

DataConnect

normalized description formatting for query parameters with enumerables
correctly documented parameters that take true or false as type: boolean
corrected some query parameters that are listed as type: string but have integer as examples and enumerables

/Reports/TradeInActivityReport

added missing required query parameter CompanyID

Nov 03, 2020

What’s Changed

DataConnect

/Availability/Product

additional description for parameter ByLocation
documented additional response schema returned as a result of the ByLocation parameter

/Reports/VendorDepositHistoryReport

removed invalid parameters

Oct 28, 2020

What’s Changed

DataConnect

updated version number that appears on top of the page to reflect the DataConnect version the document covers.

/inventory/ProductMasterList

updated parameter SearchMethod with additional usage information and usable values.

Oct 21, 2020

What’s Changed

DataConnect

added descriptions for various endpoints with missing description.
additional descriptions for the query parameters StartDate and StopDate.
normalized descriptions for fields referring to Store in Store-related functionality.
added references in the descriptions of query parameters that corresponds to a Lists/* endpoint.
made corrections to various incorrect query parameters

/Reports/InvoiceEditSummaryReport

added missing response schemas related to parameter ReportType

/Reports/CountSheetHistoryReport

added missing response schemas related to parameter ReportType

Oct 14, 2020

What’s Changed

DataConnect

corrected and removed default values for all required query parameters.
corrected optional query parameters listed as required.
removed non-existent response fields from documentation.
added undocumented response fields to documentation.
corrected response fields with incorrect/missing types and/or formats.

/Reports/TradeInActivityReport

added additional description for ProviderID query parameter.

Oct 06, 2020

What’s New

DataConnect

updated descriptions for Employee Attendance Details and Punch Revision Details endpoints

/Reports/CashAuditTrailReport

documented new functionality added in Data Connect version 1.3.1.18. See release notes for more information.

Sep 23, 2020

What’s New

Transaction Details

added additional requirement “works with RQ versions 6.28 and up”.

Supplier Cost

documented additional endpoint.

What’s Changed

DataConnect

/Reports/LoginAuditReport

added missing information in the response schema.

/Lists/VendorAccountID

added missing information in the response schema.

User Manager

made corrections to the Profiles field of User schema used by the endpoints under User Operations.

Sep 15, 2020

What’s Changed

Corrections to typos found in several API pages have been made.

Sep 04, 2020

What’s New

Transaction Details API

Transaction Details API is now live.

Sep 01, 2020

What’s Changed

Layout improvement of DataConnect pages.

DataConnect

`/Reports/productdetailreport`

added missing response fields.
corrected description of ReportPart parameter.

Aug 20, 2020

What’s Changed

DataConnect Deltas

Added missing description to response schema fields.

Jul 22, 2020

What’s Changed

Added a banner to advertise new search functionality.
Minor adjustments to wording in descriptions in Data Connect.

Jul 14, 2020

What’s Changed

Changed search to Google Programmable Search.

Jul 9, 2020

What’s Changed

Guides now have star ratings.
Added dark syntax highlighting to code samples in guides.
Added links to API reference pages that refer to another API.

Jul 6, 2020

What’s Changed

Partner Common API

`/Lists/VendorAccountID`

Corrected name from ActivityTypeID to VendorAccountID.

Jun 30, 2020

What’s Changed

Dataconnect Deltas API

updated and corrected response schemas such that the type of, format of , as well as missing/extra fields are addressed.

Jun 19, 2020

What’s Changed

DataConnect API

`/Reports/CouponSummaryReport`

added missing response schemas

Inventory Availability API

Adjusted documentation for consistency.

Jun 18, 2020

What’s Changed

Corrected broken links in Authentication guide, Vendor Inventory guide, Purchase Order API reference

Catalog API

`/Companies({CompanyId})/Catalog/Items`

includeArchived was listed as required, when it is actually optional

Coupons API

`/Companies/{CompanyId}/ValidateSerialNumbers`

Moved enumeration to description instead of top of page

Purchase Order API

`/Companies/{CompanyId}/PurchaseOrders/{PurchaseOrderId}/Receive`

Added default of -99 to EmployeeEntityId

Inventory Adjustments API

`/Companies/{CompanyId}/QuantityAdjustment`

Added default of -99 to EmployeeEntityId

Jun 17, 2020

What’s Changed

A new guide provides instructions for how to use the Inventory Adjustments API.

Authentication API

Added a new Use Cases section that links to the Authentication guide.

Vendor Services API

Added a new Use Cases section that links to the Vendor Services guide.

Jun 16, 2020

What’s Changed

Dropship API

Moved C# example to the Managing Orders page of the Dropship Guide

Sale Order API

`/Companies({CompanyId})/SaleInvoice`

Corrected description, Quantity must be > 1

`/Companies({CompanyId})/SaleOrder`

Corrected description, Quantity must be > 1

CMI API

GetVendors

Removed duplicate GetVendors tag in the example

Jun 15, 2020

What’s Changed

A new guide provides instructions for how to use the Purchase Order API.

Jun 12, 2020

What’s Changed

Made corrections to incorrectly-documented field types & examples under response schemas:
- Some field types were documented as number when it is a string and vice-versa
- Some fields had inconsistent types and examples e.g. type: number but example: false

Jun 9, 2020

What’s Changed

Added Shipping Aggregator to Client API list, as it is not specific to Partners
Removed contact form and thumbs up/down features as analytics showed they were not being used
Moved Terms link to the header and removed the footer
Fixed an issue where some pages had large gaps at bottom of the page

Sale Order API

`/Companies({CompanyId})/SaleInvoice`

UserId corrected to ReadOnly in the request body

`/Companies({CompanyId})/SaleOrder`

UserId corrected to ReadOnly in the request body

Jun 5, 2020

What’s Changed

Customers API

`/Companies({CompanyId})/CustomerFull`

added correction for fields CustomerTypeId and CustomerType

Jun 3, 2020

What’s Changed

Catalog API

Added links to parameters that are from a different API

Jun 1, 2020

What’s Changed

DataConnect API

Some common features have been removed, as they are no longer suggested for external use.

May 29, 2020

Added backup shipping options section to Dropship Onboarding Guide, Managing Orders

May 27, 2020

Adjusted the Concepts landing page to clear the separation between Partner and Client APIs, and added the authentication guide.

What’s New

DataConnect API

Rearranged Lists in alphabetical order
Corrected the documentation of the response schemas of the following endpoints:
- /Reports/SalesOrderSummaryReport
- /Reports/SalesOrderDetailReport
- /Reports/SalesByLocationReport
- /Reports/SalesByEmployeeReport

May 26, 2020

What’s New

Created a new authentication guide

May 21, 2020

What’s Changed

DataConnect API

Moved Lists below General in sidebar
Extracted FTP/FTPS/SFTP options into separate endpoint with security suggestions
Corrected the documentation of the response schemas of the following endpoints:
- /Reports/TaxDetailsNonTaxableSalesByBillPay
- /Reports/TaxDetailsNonTaxableSalesByInvoiceId
- /Reports/TaxDetailsNonTaxableSalesByInvoices
- /Reports/TaxDetailsNonTaxableSalesByProducts
- /Reports/TaxDetailsTaxableSalesByBillPay
- /Reports/TaxDetailsTaxableSalesByInvoiceId
- /Reports/TaxDetailsTaxableSalesByProducts
- /Reports/SalesOrderDetailReport
- /Reports/PerformanceGroupReport
- /Reports/SalesOrderSummaryReport

May 20, 2020

What’s Changed

DataConnect API

/Reports/CashAuditTrailReport
- updated description to address additional fields
- updated response schema with correct fields
/Reports/DailySalesSummaryReport
- updated description to address additional fields
- added missing fields in the documentation
/Reports/salesbyinvoicereport
- updated description to address additional fields
- added missing fields in the documentation
/Reports/SalesByLocationReport
- updated description to address additional fields
- updated response schema with correct fields
/Reports/RefundSummaryReport
- updated description to address additional fields
- added missing fields in the documentation

Apr 28, 2020

What’s New

Added DataConnect for Partners (Partner Common) to API landing page

Product Subscription API

Modified name of Create a Subscription List with Products to “Create or Update” and added clarification on sync time

What’s Changed

DataConnect API

/Reports/InventoryAvailabilitySummaryReport
- updated parameter SearchType’s description and example
/Reports/ProductTrackingReport
- updated parameters ProductIdentifier, SerialNumber, & AllowPartialMatches’s description to reflect conditional usage/requirements
/Reports/NonSellableProductsReport
- the docs incorrectly listed ReasonCode as required, it is now correctly listed as optional
/Reports/ManagerTimeSheetApprovalReport/PunchRevisionDetails
- added reference to response schema PunchRevisionDetails
/Lists/PaymentTypeIDs
- updated description of parameter ForWhat
/Reports/VendorRebateHistoryReport
- updated description to reflect usage
/Reports/AutoPunchOutReport
- updated description to remove outdated information
/Lists/Stores
- endpoint was removed from the documentation, it has been re-added
/Reports/DiscountSummaryReport
- endpoint was removed from the documentation, it has been re-added
Parameters LocationTypeIDs & LocationTypeIDsRequired
- updated description and example fields to correct details about it’s usage

Apr 22, 2020

What’s New

Created a new page for DataConnect Deltas. This was done to improve performance of the documentation.
Added schema descriptions to every schema in DataConnect and DataConnect Partner Common. We will continue to improve these descriptions over time.

What’s Changed

Removed “Beta” notice from DataConnect Partner Common and DataConnect.
Reorganized the initial description for DataConnect into components throughout the page

Apr 8, 2020

What’s New

Created a new Beta page for DataConnect Partner Common. In the coming months, the DataConnect Partner Common documentation will migrate to this page to consolidate all iQmetrix API documentation

What’s Changed

Access Token in Get Access Token Information has been fixed and now reads access_token correctly
The Beta warning was removed from the Vendor Services Guide
The missing Curation link was added to the landing page

Apr 1, 2020

The new API reference design using ReDoc and OAS has rolled out!

Two pages remain the same:

CMI - SOAP API incompatible with ReDoc
VMI - SOAP API incompatible with ReDoc

As part of the change, the documentation was consolidated so each API has a single page for API documentation.

We appreciate your patience as we work through this transition.

What’s New

Endless Aisle, RQ and eCommerce images on home page have been replaced with new ones
The Beta Reader page has been removed
The Cost Feed, Supplier Availability and Supplier Orders API pages now redirect to the NEW Dropship API page
The Product Feed API page now redirects to the NEW Curation API page
The Company Tree API page now redirects to the Entity Manager page
The Classification Tree and Field Definitions API pages now redirect to the NEW Product Library page
The Security Roles API page now redirects to the User Manager API page
The Landing page lists the new pages, as well as Shipping Options, which was missing
A new Beta page for DataConnect was created. In the coming months, the DataConnect documentation will migrate to this page to consolidate all iQmetrix API documentation
The Creating an In Store Order guide has been removed as it was very out of date and no longer relevant
The Endless Aisle and Creating an In Store Order Guide are removed from the Guides landing page
Learn More buttons on the home page have been removed
The “Product” tab in the navbar has been removed to streamline navigation

Feb 12, 2020

What’s New

Additional Endpoints have been added to the Beta Page
- Entity Manager
  - Retreive Division Details
  - Retreive Group Details
- Catalog
  - Get Catalog Items by Product Library Identifier
  - Get Catalog Items by External Identifier
  - Get Catalog Items by Catalog SKU
  - Get Catalog Items by Manufacturer SKU

Feb 5, 2020

Fixed Issues

Customers API
- Contact method value cannot have dashes, updated contact method values to remove dashes
- Fixed links for CustomerTypeID by changing to CustomerType and AddressTypeID by changing to AddressType
YAML Files (Beta Reader)
- Removed Redundant Accept and Content Type headers
- Resolve recursion issue in Entity Manager, Company Tree Node

Jan 29, 2020

What’s New

A feedback form has been added to the Beta Page
A notice has been added to Catalog, Coupons and Purchase Order references pointing to the Beta Reader page
Out of date Examples page has been removed from the Footer of each page

Jan 15, 2020

What’s New

The following APIs have been added to the Beta Page
- Accounts, Catalog, CRM, Enterprise Product Catalog (EPC), Order, Product Library, Product Subscriptions, Reference

What’s Changed

Removed the Beta notice from Vendor Inventory API reference
Reorganized the API index page to make it more clear which APIs are intended for which audience

Dec 11, 2019

What’s New

A new Beta Page has been added, which displays the new ReDoc styling for the developer portal API reference pages, generated from OAS (Open API Specifications). This styling will be rolled out to all (/api/*) pages in 2020
Sales Order API
- Clarified how taxes are applied by default in TaxLineItems throughout
- New optional property, UseRQTaxation added to Post a Sales Order and Create an Invoice and Post a Sales Order With No Invoice. When true, taxes will be applied automatically following RQ tax rules. Taxes included in the request on the SaleOrderItem array will also be included, but this is not recommended. Default value is false.
Vendor Inventory renamed to Vendor Services, the URL will remain the same to preserve bookmarks

Nov 13, 2019

Fixed Issues

Security Roles API]
- Unassigning a Security Role from a User previously listed SecurityRoleId as a parameter. The correct parameter is SecurityRoleAssignmentId and has been fixed

Oct 23, 2019

What’s New

Purchase Order API
- Added a note to clarify that all products must be Mapped to Product Library with a corresponding vendor SKU if Vendor SKUs are used in the request payload
- RQ version required updated to 6.20
Inventory Adjustment API
- Added a note to clarify that all products must be Mapped to Product Library with a corresponding vendor SKU if Vendor SKUs are used in the request payload
- Added a note to clarify Unit cost - this value must be positive and if not provided, the default unit cost will be used as configured in RQ

Fixed Issues

Inventory Availability API
- The Pagination section previously said “User Manager”, this has been corrected

Oct 10, 2019

What’s New

Purchase Order API
- Creating a Purchase Order and Receiving a Purchase Order now support input with a UnitCost of NULL in RQ Database versions of 6.20.105.15181 or higher.
  - If a UnitCost of NULL is provided, the product’s default unit cost (as configured within the Windows desktop application for RQ) will be used instead.
  - The default unit cost for a product may be configured in the RQ application for Windows desktop.
Inventory Adjustment API
- Quantity Adjustments no longer require a Unit Cost

Oct 2, 2019

What’s New

The Purchase Order and Inventory Adjustment API have been added to the index page
The Purchase Order and Inventory Adjustment API have been updated to note the RQ version requirement for these APIs, 6.19+

Fixed Issues

The Purchase Orders API Documentation was…
- Fixed to remove a /v1 from the URL, the API does not have a v1
- Missing the PurchaseOrderId in the Retreive endpoint URI, it has now been added
- Missing descriptions for several fields, these have been added
The Inventory Adjustments API Documentation was…
- Missing descriptions for several fields, these have been added

Sep 18, 2019

What’s New

New API reference, Purchase Orders
New API reference, Inventory Adjustments
New Endpoint documented, Create a Private Product which allows you to create a private CatalogItem in your Catalog