NutraSoft food manufacturing ERP software
Esc
  • GuideGetting startedThree steps to your first call and your first order, then the two shapes every response takes.
  • GuideAuthentication and keysBearer keys, test and live environments, rotation without an outage, and what each scope grants.
  • GuideTest modeA second NutraSoft account of your own, seeded with realistic data, that you can safely break.
  • PageErrorsEvery error code the API returns, what it means, what to do about it and whether to retry.
  • PageConventionsThe rules every operation follows: money, time, paging, sorting, nulls, PATCH and identifiers.
Menu

Versioning and support

What v1 promises never to change, how a breaking change would reach you with 12 months' notice, and how to reach support.
Updated

In short

  • /v1 only grows: nothing in it is removed, renamed or retyped.
  • Tolerate unknown fields and unknown enum members, or a compatible addition will break you.
  • A breaking change ships as /v2 alongside v1, with at least 12 months' notice.
  • For support, write to support@nutrasoft.ca with the request_id. Never send the key.

v1 only grows

/v1 is additive only. We add operations, optional request fields, response fields, enum members and error codes. We never remove or rename any of them, never change a field's type, and never make an optional request field required. Every change to the API is checked against the published OpenAPI document before it ships, and a change that would break v1 is refused.

Two things you must tolerate to stay compatible:

  • Unknown enum members. We add them. A switch with no default branch, or a database check constraint listing today's values, will break on an addition that is compatible by our definition.
  • Unknown JSON fields. We add those too. Parse permissively.

Breaking changes

A breaking change ships as a new version, /v2, alongside v1, never as an edit in place. We give at least 12 months' notice before a version is retired: by email to your account owner, in the changelog, and on every response from the retiring version through the Deprecation, Sunset and Link headers.

Security or legal requirements can occasionally force a faster change. When they do, we tell you as early as we can.

Support

  • Email support@nutrasoft.ca or call 1-888-775-5730, Monday to Friday, 9 AM to 5 PM Eastern.
  • Include the request_id of the failing request, the api_key_id from GET /organization, the operation, the status you got and the time in UTC.
  • Never send the key itself. We will never ask for it.

Terms

Use of the API is governed by the NutraSoft Terms of Service.