Products

Raw materials, packaging, recipes and finished goods in one resource with two families. Read-only in v1.

catalog:readhttps://public-api.nutrasoft.ca/v1

Links toFoodsmaterial.food_id Suppliersmaterial.supplier_ids Countriesmaterial.banned_country_ids QC checkpointsrecipe.qc_checkpoint_ids Allergensallergens[].allergen_id Tagstag_ids Units of measureunit_of_measure_id

Linked fromProduct lotsproduct_id Productionsproduct_id Sales orderslines[].product_id Invoiceslines[].product_id Purchase orderslines[].product_id Billslines[].product_id

The Product object

idinteger
activeboolean
allergensarray of objectsnullable
On GET /products/{product_id} only; null on the list.
ShowHide 5 fields of allergens
- allergen_idinteger
- codestringnullable
- is_major_allergenboolean
- namestringnullable
- sourcestring
  declared: recorded directly against this product.
costnumbernullable
Cost per inventory unit. Requires cost:read; null means redacted, not zero. Separate from operations_cost.
created_atstringnullable
- UTC timestamp
descriptionstringnullable
is_deletedboolean
kindstring
Derived from product_type. Says which of material and recipe is populated.
- one ofmaterialrecipe
materialobjectnullable
Populated only when kind is material.
ShowHide 4 fields of material
- banned_country_idsarray of integer
- food_idintegernullable
  The nutrition source. Fetch with GET /foods/{food_id}.
- substitute_product_idsarray of integer
- supplier_idsarray of integer
namestringnullable

Show 11 more attributes

operations_costnumbernullable
Operations cost per inventory unit. Requires cost:read.
product_codestringnullable
product_typestring
- one ofRAW_MATERIALPACKAGINGMISCELLANEOUSRECIPESUB_RECIPEFINISHED_GOOD
recipeobjectnullable
Populated only when kind is recipe.
ShowHide 6 fields of recipe
- byproduct_product_idsarray of integer
- ingredients_enstringnullable
  The generated ingredient declaration.
- ingredients_frstringnullable
- portion_in_gramsnumbernullable
- qc_checkpoint_idsarray of integer
- recipe_grams_yieldnumbernullable
shelf_lifeintegernullable
tag_idsarray of integernullable
On GET /products/{product_id} only; null on the list.
unit_of_measure_idintegernullable
uom_base_conversionnumbernullable
Second conversion factor. See uom_qty.
uom_base_idintegernullable
uom_qtynumbernullable
First conversion factor. One inventory unit is uom_qty * uom_base_conversion base units.
updated_atstringnullable
- UTC timestamp

Product families

Fields each product family carries
Field	Material	Recipe
product_type	RAW_MATERIAL, PACKAGING, MISCELLANEOUS	RECIPE, SUB_RECIPE, FINISHED_GOOD
kind	material	recipe
material.banned_country_ids	Yes	No, `material` is null
material.food_idThe nutrition source. Fetch with `GET /foods/{food_id}`.	Yes	No, `material` is null
material.substitute_product_ids	Yes	No, `material` is null
material.supplier_ids	Yes	No, `material` is null
recipe.byproduct_product_ids	No, `recipe` is null	Yes
recipe.ingredients_enThe generated ingredient declaration.	No, `recipe` is null	Yes
recipe.ingredients_fr	No, `recipe` is null	Yes
recipe.portion_in_grams	No, `recipe` is null	Yes
recipe.qc_checkpoint_ids	No, `recipe` is null	Yes
recipe.recipe_grams_yield	No, `recipe` is null	Yes
Allergensallergens[].allergen_id	Yes	Yes
Tagstag_ids	Yes	Yes
Units of measureunit_of_measure_id	Yes	Yes
Product lotslinked by product_id	Yes	Yes

Operations

List products

get/productscatalog:read

One table, two families: every row carries kind, material or recipe. allergens, tag_ids, material and recipe are null here: retrieve a product for them.

Query parameters

namestringnullable
Partial match.
product_codestringnullable
Partial match.
product_typesarray of stringnullable
Repeat the parameter to match any of several types.
- one ofRAW_MATERIALPACKAGINGMISCELLANEOUSRECIPESUB_RECIPEFINISHED_GOOD
searchstringnullable
Free-text match.
sortstringnullable
Comma-separated field:direction pairs, e.g. id:desc. Sortable: created_at, id, name, product_code, product_type, updated_at. id is always added last, so paging is stable.
limitinteger
Rows to return. Maximum 200.
- >= 1
- <= 200
- default 50
offsetinteger
Rows to skip. Maximum 10000: to read further, narrow the filters or page with updated_since.
- >= 0
- <= 10000
- default 0
updated_sincestringnullable
Only rows changed after this instant, as an ISO 8601 timestamp; without an offset it is read as UTC. Tracks the record itself, not its child rows, and deletions are not reported, so reconcile by re-listing from time to time.
- UTC timestamp

Returns

200 A page of Product objects in data, with pagination.

Errors

400 401 403 429 500 503

GET /products

curl "https://public-api.nutrasoft.ca/v1/products?limit=50" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": [
    {
      "id": 123,
      "active": true,
      "allergens": null,
      "cost": 12.5,
      "created_at": "2026-09-10T14:30:00Z",
      "description": "string",
      "is_deleted": false,
      "kind": "material",
      "material": {
        "banned_country_ids": [
          123
        ],
        "food_id": 123,
        "substitute_product_ids": [
          123
        ],
        "supplier_ids": [
          123
        ]
      },
      "name": "Sample name",
      "operations_cost": 12.5,
      "product_code": "SAMPLE-01",
      "product_type": "RAW_MATERIAL",
      "recipe": null,
      "shelf_life": 10,
      "tag_ids": null,
      "unit_of_measure_id": 123,
      "uom_base_conversion": 12.5,
      "uom_base_id": 123,
      "uom_qty": 12.5,
      "updated_at": "2026-09-10T14:30:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  },
  "order": "id:asc"
}

Retrieve a product

get/products/{product_id}catalog:read

Exactly one of material and recipe is populated, as kind says. The bill of materials is not published in v1.

Path parameters

product_idintegerrequired
The product's id.
- > 0

Returns

200 One Product object in data.

Errors

400 401 403 404 429 500 503

GET /products/{product_id}

curl "https://public-api.nutrasoft.ca/v1/products/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "id": 123,
    "active": true,
    "allergens": [
      {
        "allergen_id": 123,
        "code": "SAMPLE-01",
        "is_major_allergen": false,
        "name": "Sample name",
        "source": "string"
      }
    ],
    "cost": 12.5,
    "created_at": "2026-09-10T14:30:00Z",
    "description": "string",
    "is_deleted": false,
    "kind": "material",
    "material": {
      "banned_country_ids": [
        123
      ],
      "food_id": 123,
      "substitute_product_ids": [
        123
      ],
      "supplier_ids": [
        123
      ]
    },
    "name": "Sample name",
    "operations_cost": 12.5,
    "product_code": "SAMPLE-01",
    "product_type": "RAW_MATERIAL",
    "recipe": null,
    "shelf_life": 10,
    "tag_ids": [
      123
    ],
    "unit_of_measure_id": 123,
    "uom_base_conversion": 12.5,
    "uom_base_id": 123,
    "uom_qty": 12.5,
    "updated_at": "2026-09-10T14:30:00Z"
  }
}