Each GrubOne endpoint is versioned independently. The base endpoint is considered as v1. Any non backwards compatible change will cause the version number to be incremented. Any deprecations will be marked as such and should be avoided if you are doing a new integration.

Deprecated endpoints and attributes will be supported for 3 months. We will notify you in advance of a breaking change with periodic notices. You will be required to change the implementation within this time frame.

Backwards Compatible Changes

These changes will not trigger a version bump. Most REST API implementations would not be affected by these changes. We are including these so that you can make sure theses can be handled by your tech stack.

• Introducing new endpoints
• Changing mandatory attributes to optional
• Changing parameters such as enums to accept additional values
• Introducing new optional request parameters.
• Introducing new response attributes
• Changing error message text content.

Non Backwards Compatible Changes

A new API version will be released for the following changes.

• Introducing new required request attributes
• Removing a mandatory response attribute
• Renaming existing attributes
• Changing fundamental architectural or pre defined workflows such as order notification handshake.