REST API Menu.xml Overview The REST API allows developers to interract programatically with deployments.

More specifically, the API has been designed with the following use cases in mind:
  • Signing users into deployments and synchronising accounts
The REST API is JSON-based, and uses JWT to authenticate calls.

 Release Notes

2.8

  • GET Products fix - fixed an issue with GET Products/ failing when tax rates are not set.

2.7

  • Order and item raw price - prices before discounts are shown in addition to totals.
  • Product tax category - tax category name and rate added to the Product call.
  • Tax inclusive pricing - tax inclusive pricing displayed in the new Settings call.

2.6

  • Payment fields fix - fix of the method that returns payment fields.

2.5

  • Callbacks URL format - added support for various formats of the callback URL.
  • Error handling - error handling of callback registration issues has been improved.

2.4

  • Output paths - added output path and created date item calls.

2.3

  • Time filters - added time filters to orders and items calls.

2.2

  • Order approvals improvement - additional HTTP codes and response messages added.

2.1

  • Payment fields - new call added to get payment fields for an order.
  • Order approvals - new call added to allow the approval of an order.
  • Callbacks fix - bug fix to the OrderCreated callback to trigger when orders have approvals.

2.0

  • Performance optimisation - performance optimisation of all calls with custom fields.

1.9

  • Null metafields - null values removed from product metafields.
  • Performance optimisation - performance of product related calls increased.

1.8

  • Get user by UserID - updated get users call to retrieve by User ID.
  • Compatibility - compatibility improvements with Storefront 9.4 and 9.5.

1.7

  • Orders - fix of the 'from' / 'to' parameters logic for orders and order items calls.

1.6

  • Security - support for TLS 1.2 added to callbacks.
  • Debug logging - extended debug logging of API requests added.

1.5

  • Performance - compatibility with extensions that retrieve data from remote data sources.
  • Custom Fields - call responses now contain only custom fields with definition.

1.4

  • Callbacks - functionality of Callbacks introduced.

1.3

  • Users - reverted login ticket response to lower case.

1.2

  • Products, Permissions, Orders - calls for products, permissions, orders and ordered documents added.

1.1

  • Users and Groups - user and group calls added.

1.0

  • Initial Release - calls for SSO added.