Versioning

The API version is part of the URL: https://back.goorder.com/api/partner/v1. A new major version (/v2) is introduced only when we must make a breaking change.

Changes that never need a new version

We may do these at any time, so build your client to tolerate them:

• Adding endpoints, optional request fields and response fields
• Adding webhook event types — ignore types you do not handle
• Adding enum values (for example a new order status or error code) — treat unknown values as “other”
• Adding error codes within an existing HTTP status
• Changing the wording of error.message, the order of fields, or the length of ids

Parse responses leniently: read the fields you need, ignore the rest, and never fail on an unknown field or enum value.

Breaking changes

These ship only in a new major version:

• Removing or renaming a field, endpoint or event
• Changing the type or meaning of a field
• Making an optional request field required
• Changing the signature scheme of webhooks

Deprecation policy

When a new major version is released:

1. The previous version keeps working for a minimum overlap period announced with the release.
2. Deprecated endpoints return a Deprecation response header, and the changelog and your account contact announce the sunset date.
3. We contact each affected partner directly before anything is switched off.

Staying informed

• Read the Changelog.
• Make sure your account has a technical contact that reads email — that is where deprecation notices go.