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

Changelog

What changed in the NutraSoft API, newest first.

/v1 is additive only: operations, fields, enum members and error codes are added, never removed, renamed or retyped. A breaking change would ship as /v2 alongside v1, with at least 12 months' notice. Tolerate unknown fields and unknown enum members to stay compatible. See Versioning and support.

v1.1

Webhooks: we tell you when something changes, instead of you asking.

Added

  • Webhooks: register an https:// endpoint in Settings, Developer, and we POST a signed JSON envelope within a minute of a change.
  • 60 events across 17 objects: sales orders, invoices, customers, purchase orders, bills, suppliers, production runs, lots, products, warehouses, equipment, production lines, operations, tags, units of measure, allergens and foods. The full list is under Webhook events.
  • .updated also fires when one of a document's own lines changes, carrying the parent's id, which updated_since polling cannot see.
  • Every event carries source, naming what caused the change, so an integration that writes back to NutraSoft can ignore its own echo.
  • A test event button that sends a signed ping to your real URL and shows you exactly what came back.
  • A delivery log per endpoint, kept 30 days with what we sent and what your server answered, and a Send again button you can press at any time, as often as you like, including while a delivery is waiting out its retry gap. A delivery we gave up on keeps its record for 90 days, so a failure can still be looked at long after the fact.

Notes

  • No new operations: the REST surface is unchanged. The topics are published in the OpenAPI document's 3.1 webhooks object.
  • Delivery is at least once and is not ordered. Deduplicate on the event id and treat snapshot as a routing aid, never as the record.
  • Your endpoint has 15 seconds to answer. A delivery that does not get a 2xx is retried three times, five hours apart, about 15 hours in all. An endpoint that fails everything for a day is switched off and its owner emailed; nothing is deleted.
  • Webhook endpoints are created by a signed-in user with Developer access, not by an API key.

v1.0

The first public release of the NutraSoft API.

Added

  • Catalog: products (read-only), allergens, foods, tags and units of measure with writes, plus QC checkpoints, QC units of measure, preservations, countries and nutrients.
  • Inventory: product lots (create, update, archive, unarchive) and warehouses.
  • Manufacturing: production runs with status changes, production lines, operations, equipment and employees.
  • Sales: customers and their shipping addresses, sales orders with cancel, invoices, and the customer reference lists: customer types, price lists, salespersons, shipping methods, tax rates and territories.
  • Purchasing: suppliers, purchase orders with status changes, and bills that receive stock.
  • GET /organization, which needs no scope and reports the key's account, environment, scopes, rate limit and currency.
  • updated_since, created_at and updated_at on products, product lots, sales orders, invoices, purchase orders, customers and suppliers.
  • Test mode: a separate test account of your own with nsk_test_ keys.

Notes

  • Document lines are returned on detail and write operations. Line lists accept 1 to 200 lines; bills count distinct products, with up to 1000 lines.
  • Idempotency-Key is accepted on POST /bills and POST /purchase-orders.
  • Not in v1: product writes, a bill of materials, tax amounts and document totals, and sending API-created bills to QuickBooks.