Versioning & Upgrade Timelines
Uber Eats Marketplace APIs are versioned at the endpoint-level. With the exception of privacy or security fixes, introduction of a backwards-incompatible change will result in the version number of the API being incremented. Superseded API versions will be marked as deprecated whenever newer APIs are released.
Deprecated APIs will be supported for 3 months, but will not be actively developed or receive new features. Partners will be expected to migrate to the new versions of the API within this time, after which access to the old APIs will be cut off.
¶ Backwards-Compatible Changes
Any of these changes would not necessarily warrant a version bump. Please review these carefully to make sure your system will be resilient to such changes.
- Adding an entirely new endpoint.
- Marking a previously required request parameter as optional.
- Allowing a request parameter to accept additional values/types.
- Adding a new optional request parameter.
- Adding new response field(s).
- Adding new enum value(s) to either a request/response field.
- Refining error code numbers or human readable error messages (e.g. reclassifying HTTP error 500 as error 400, or adding more context to the error message string).
¶ Backwards-Incompatible Changes
Any of these changes would warrant a version bump:
- Adding a new required request parameter.
- Removing a non-nullable response field.
- Changing an existing parameter name.
- Fundamentally changing the underlying behavior of a write endpoint for a given set of inputs.