Skip to main content

Versioning

When we introduce breaking changes to our APIs, we increase the version number in the the endpoint path.

For example:

  • Get Daily Financials has the path: /f/finance/{businessLocationId}/dailyFinancials
  • Its v2 counterpart, Get Sales has the path /f/v2/business-location/{businessLocationId}/sales

We will also continue to bring backwards compatible (non-breaking) improvements to our existing APIs.

Changelog​

Any API versioning and updates are communicated using the API Reference's Changelog.

Breaking Changes​

Examples of breaking changes:

  • Removing an API Resource
  • Removing properties from API Responses
  • Adding new required parameters

Non-Breaking Changes​

Examples of things considered to be non-breaking/backwards compatible changes:

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings. Strings that are marked as const or enum in this documentation will not change.