Change History

The following table describes additions and updates to the API. Document 11648 on the Customer Support Portal lists bugs fixed in API releases.

Date Change Type Release Version Description
December 2022 Release 23.1 Initial release
April 2023 Release 23.2 Added the following endpoints:
Updated the following endpoints:
June 2023 Release 23.2.2

Added Menu Item Group Details endpoint.

Added fields (in parentheses) to the following endpoints:
  • GetHierarchy (locRef, parentLocRef, hierStrucId, parentHierStrucId)

  • GetLocations (locRef, hierStrucId)

  • GetRevenueCentres (hierStrucId, locHierStrucId)

  • GetZones (hierStrucId, parentHierStrucId)

  • Barcodes (leadNumZeros)

October 2023 Release 23.3
Updated the following endpoints to retrieve records for all hierarchies:

All GET operations now have the option includeAll to retrieve all fields that can be configured for an entity.

The Simphony-OrgShortName header parameter will now be ignored. See Header Parameters for more information.

March 2024 Release 23.3.1
March 2024 Release 23.3.1.2 The hierUnitId parameter is no longer required for Menu Level Entry endpoint GET requests.
April 2024 Release 23.3.1.3

Updated endpoint Locations.

April 2024 Release 23.3.1.4 This release contains bug fixes. See Document 11648 for more information.