> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/evo-recipes-api/products.md).

# Products

Product (ingredient) directory with allergen and category data

## List products

> Returns a projection of products (ingredients) for the authenticated organisation, ordered by name ascending. Defaults to active products that are in use — referenced by a component of a published, active recipe.

```json
{"openapi":"3.0.1","info":{"title":"EvoDishesRecipes APIM Operations API","version":"0.1"},"tags":[{"name":"Products","description":"Product (ingredient) directory with allergen and category data"}],"servers":[{"url":"https://api.hos.accessacloud.com/evo/dishes-recipes/v1","description":"Production"},{"url":"https://api-dev.hos.accessacloud.com/evo/dishes-recipes/v1","description":"Development"},{"url":"https://api-staging.hos.accessacloud.com/evo/dishes-recipes/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 client credentials JWT obtained from the Access Identity M2M token endpoint (`POST https://api.hos.accessacloud.com/platform/m2m-auth/v1/token`). The token request must use `grant_type=client_credentials` with `audience=fandb-platform-api evo-dishes-recipes` and `scope=fandb.read fandb.write openid <organisationId>`, where `<organisationId>` is the calling organisation's GUID. The response returns `{ \"access_token\": \"<JWT>\", \"expires_in\": 3599, \"scope\": \"fandb.read fandb.write openid <organisationId>\", \"token_type\": \"bearer\" }`. Tokens expire after `expires_in` seconds (typically ~1 hour). APIM validates the token at the gateway. The token's `scp` claim must also carry the caller's organisation ID as a bare GUID; the backend resolves the tenant by matching that GUID case-insensitively against either the `id` or the `workspace_org_id` column. A token with no organisation GUID is rejected with `401`, and one carrying more than one distinct organisation GUID with `403`."}},"parameters":{"PageSize":{"name":"page_size","in":"query","required":false,"description":"Number of items per page. Clamped to the range [1, 500]. Defaults to 100.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},"Cursor":{"name":"cursor","in":"query","required":false,"description":"Opaque cursor for keyset pagination. Pass the next_cursor value from a previous response to fetch the next page.","schema":{"type":"string"}},"ActiveFilter":{"name":"active","in":"query","required":false,"description":"Filter on the active flag. Use `all` to disable the filter. Defaults to `true`.","schema":{"type":"string","enum":["true","false","all"],"default":"true"}},"InUseFilter":{"name":"inUse","in":"query","required":false,"description":"Restrict to products referenced by a component of a published, active recipe (`true`), products with no such reference (`false`), or disable the filter (`all`). Defaults to `true`.","schema":{"type":"string","enum":["true","false","all"],"default":"true"}},"UpdatedSince":{"name":"updatedSince","in":"query","required":false,"description":"ISO 8601 timestamp. Returns only records updated at or after this instant, ordered by `updatedAt` ascending for incremental sync.","schema":{"type":"string","format":"date-time"}}},"schemas":{"PaginatedResponse":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"Pagination":{"type":"object","required":["page_size","has_next_page","next_cursor"],"properties":{"page_size":{"type":"integer","description":"The page size used for this request."},"has_next_page":{"type":"boolean","description":"Whether more results exist beyond this page."},"next_cursor":{"type":"string","nullable":true,"description":"Cursor to pass as the cursor query parameter for the next page. Null when there are no more results."}}},"Product":{"type":"object","description":"Product (ingredient) list projection. Cost fields are deliberately excluded from this API.","required":["id","name","active","allergens","tags","updatedAt"],"properties":{"id":{"type":"string","description":"Unique product identifier (CUID)."},"name":{"type":"string"},"description":{"type":"string","nullable":true,"description":"Free-text product description (not the pack size)."},"imageUrl":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"active":{"type":"boolean"},"category":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/IngredientCategoryRef"}]},"allergens":{"type":"array","items":{"$ref":"#/components/schemas/AllergenRef"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagRef"}},"updatedAt":{"type":"string","format":"date-time"}}},"IngredientCategoryRef":{"type":"object","description":"Lightweight reference to an ingredient category.","required":["id","categoryName","categoryCode"],"properties":{"id":{"type":"string"},"categoryName":{"type":"string"},"categoryCode":{"type":"string"}}},"AllergenRef":{"type":"object","description":"Lightweight allergen reference as included on a product.","required":["id","code","name","severity"],"properties":{"id":{"type":"string"},"code":{"type":"string","description":"Unique allergen code (e.g. CELERY, EGGS, MILK)."},"name":{"type":"string"},"severity":{"type":"string","enum":["MILD","MODERATE","SEVERE","LIFE_THREATENING"]}}},"TagRef":{"type":"object","description":"Lightweight reference to a tag.","required":["id","name","color"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","description":"Hex colour code."}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message."},"code":{"type":"string","description":"Stable machine-readable error code (e.g. INVALID_QUERY_PARAMETER, MISSING_PATH_PARAMETER, RESOURCE_NOT_FOUND, INTERNAL_ERROR)."},"parameter":{"type":"string","description":"The offending query or path parameter, when applicable."}}}},"responses":{"BadRequest":{"description":"A query or path parameter failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing, invalid, or expired authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token does not grant access to exactly one organisation, so no tenant can be resolved from it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"OrganizationNotFound":{"description":"No tenant found matching the organisation GUID in the token's `scp` claim.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/apim/products":{"get":{"operationId":"GetProducts","summary":"List products","description":"Returns a projection of products (ingredients) for the authenticated organisation, ordered by name ascending. Defaults to active products that are in use — referenced by a component of a published, active recipe.","tags":["Products"],"parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/ActiveFilter"},{"$ref":"#/components/parameters/InUseFilter"},{"$ref":"#/components/parameters/UpdatedSince"}],"responses":{"200":{"description":"Paginated list of products.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/OrganizationNotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## Get a product

> Returns one product (ingredient) with its stored allergen associations, stored nutrition, dietary suitability, ingredient declaration, category, tags, raw pack fields and up to 50 active supplier offers. Nutrition prefers the current \`IngredientNutrition\` row and falls back to the current \`OfferNutrition\` row of an active offer; \`nutrition.source\` says which was used. \`packDisplay\` is not returned — it is a calculated field that today only exists in \`packages/graphql\`, so the raw fields it is derived from are exposed under \`pack\` instead. Cost, GP and margin figures are deliberately excluded.

```json
{"openapi":"3.0.1","info":{"title":"EvoDishesRecipes APIM Operations API","version":"0.1"},"tags":[{"name":"Products","description":"Product (ingredient) directory with allergen and category data"}],"servers":[{"url":"https://api.hos.accessacloud.com/evo/dishes-recipes/v1","description":"Production"},{"url":"https://api-dev.hos.accessacloud.com/evo/dishes-recipes/v1","description":"Development"},{"url":"https://api-staging.hos.accessacloud.com/evo/dishes-recipes/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 client credentials JWT obtained from the Access Identity M2M token endpoint (`POST https://api.hos.accessacloud.com/platform/m2m-auth/v1/token`). The token request must use `grant_type=client_credentials` with `audience=fandb-platform-api evo-dishes-recipes` and `scope=fandb.read fandb.write openid <organisationId>`, where `<organisationId>` is the calling organisation's GUID. The response returns `{ \"access_token\": \"<JWT>\", \"expires_in\": 3599, \"scope\": \"fandb.read fandb.write openid <organisationId>\", \"token_type\": \"bearer\" }`. Tokens expire after `expires_in` seconds (typically ~1 hour). APIM validates the token at the gateway. The token's `scp` claim must also carry the caller's organisation ID as a bare GUID; the backend resolves the tenant by matching that GUID case-insensitively against either the `id` or the `workspace_org_id` column. A token with no organisation GUID is rejected with `401`, and one carrying more than one distinct organisation GUID with `403`."}},"parameters":{"ProductId":{"name":"productId","in":"path","required":true,"description":"The product (ingredient) id, which must belong to the authenticated organisation.","schema":{"type":"string"}}},"schemas":{"ProductDetail":{"type":"object","description":"Product (ingredient) detail. Cost fields are deliberately excluded from this API, and `packDisplay` is not returned.","required":["id","name","active","isNonConsumable","fvnCategory","fvnPercent","pack","tags","allergens","supplierOffers","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true,"description":"Free-text product description (not the pack size)."},"imageUrl":{"type":"string","nullable":true},"productCode":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"active":{"type":"boolean"},"isNonConsumable":{"type":"boolean"},"ingredientDeclaration":{"type":"string","nullable":true},"fvnCategory":{"type":"string","enum":["FRUIT","VEGETABLE","NUT","SEED","NONE"]},"fvnPercent":{"type":"string","format":"decimal"},"weightPerUnitG":{"type":"string","format":"decimal","nullable":true},"densityGramsPerMl":{"type":"string","format":"decimal","nullable":true},"sourceSystem":{"type":"string","nullable":true},"defaultUnit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/UnitRef"}]},"category":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/IngredientCategoryRef"}]},"pack":{"$ref":"#/components/schemas/ProductPack"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagRef"}},"allergens":{"type":"array","items":{"$ref":"#/components/schemas/AllergenAssociation"}},"dietarySuitability":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/DietarySuitability"}]},"nutrition":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductNutrition"}]},"supplierOffers":{"type":"array","description":"Active offers, capped at 50.","items":{"$ref":"#/components/schemas/SupplierOfferSummary"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"UnitRef":{"type":"object","description":"Lightweight reference to a measurement unit.","required":["id","name","abbreviation","unitType"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"},"unitType":{"type":"string","enum":["WEIGHT","VOLUME","COUNT"]}}},"IngredientCategoryRef":{"type":"object","description":"Lightweight reference to an ingredient category.","required":["id","categoryName","categoryCode"],"properties":{"id":{"type":"string"},"categoryName":{"type":"string"},"categoryCode":{"type":"string"}}},"ProductPack":{"type":"object","description":"Raw stored pack fields. The calculated `packDisplay` string is not returned by this API — see the endpoint description.","properties":{"packsInCase":{"type":"integer","nullable":true},"unitsInPack":{"type":"integer","nullable":true},"unitCount":{"type":"integer","nullable":true},"unitSize":{"type":"string","format":"decimal","nullable":true},"unitMeasure":{"type":"string","nullable":true}}},"TagRef":{"type":"object","description":"Lightweight reference to a tag.","required":["id","name","color"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","description":"Hex colour code."}}},"AllergenAssociation":{"description":"Allergen as stored against an ingredient or supplier offer. `status` is the recorded association, never a calculated roll-up.","allOf":[{"$ref":"#/components/schemas/AllergenRef"},{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["NO","YES","MAY_CONTAIN"]}}}]},"AllergenRef":{"type":"object","description":"Lightweight allergen reference as included on a product.","required":["id","code","name","severity"],"properties":{"id":{"type":"string"},"code":{"type":"string","description":"Unique allergen code (e.g. CELERY, EGGS, MILK)."},"name":{"type":"string"},"severity":{"type":"string","enum":["MILD","MODERATE","SEVERE","LIFE_THREATENING"]}}},"DietarySuitability":{"type":"object","description":"Stored dietary-suitability flags. Nulls mean \"not declared\".","properties":{"isVegetarian":{"type":"boolean","nullable":true},"isVegan":{"type":"boolean","nullable":true},"isDairyFree":{"type":"boolean","nullable":true},"isGlutenFree":{"type":"boolean","nullable":true},"isLactoseFree":{"type":"boolean","nullable":true},"isNutFree":{"type":"boolean","nullable":true},"isHalalSuitable":{"type":"boolean","nullable":true},"isKosherSuitable":{"type":"boolean","nullable":true},"isHinduismSuitable":{"type":"boolean","nullable":true}}},"ProductNutrition":{"description":"Stored nutrition resolved for a product, tagged with where it came from.","allOf":[{"$ref":"#/components/schemas/StoredNutrition"},{"type":"object","required":["source"],"properties":{"source":{"type":"string","enum":["INGREDIENT","OFFER"]},"offerId":{"type":"string","nullable":true,"description":"The offer the row came from when source is OFFER."}}}]},"StoredNutrition":{"description":"Current stored nutrition row of an ingredient (`IngredientNutrition`) or a supplier offer (`OfferNutrition`). Never an aggregate.","allOf":[{"$ref":"#/components/schemas/NutritionValues"},{"type":"object","required":["referenceUnit","dataSource","version"],"properties":{"referenceUnit":{"type":"string"},"dataSource":{"type":"string"},"sourceReference":{"type":"string","nullable":true},"verifiedAt":{"type":"string","format":"date-time","nullable":true},"version":{"type":"integer"}}}]},"NutritionValues":{"type":"object","description":"Big-8 plus extended nutrition values. Decimal columns are serialised as strings to preserve precision.","properties":{"energyKcal":{"type":"string","format":"decimal","nullable":true},"energyKj":{"type":"string","format":"decimal","nullable":true},"fatG":{"type":"string","format":"decimal","nullable":true},"saturatedFatG":{"type":"string","format":"decimal","nullable":true},"carbohydrateG":{"type":"string","format":"decimal","nullable":true},"sugarsG":{"type":"string","format":"decimal","nullable":true},"proteinG":{"type":"string","format":"decimal","nullable":true},"saltG":{"type":"string","format":"decimal","nullable":true},"fibreG":{"type":"string","format":"decimal","nullable":true},"monoUnsaturatesG":{"type":"string","format":"decimal","nullable":true},"polyUnsaturatesG":{"type":"string","format":"decimal","nullable":true},"transFatG":{"type":"string","format":"decimal","nullable":true},"sodiumMg":{"type":"string","format":"decimal","nullable":true},"freeSugarsG":{"type":"string","format":"decimal","nullable":true}}},"SupplierOfferSummary":{"type":"object","description":"Active supplier offer for the product.","required":["id","supplier","hasNutrition"],"properties":{"id":{"type":"string"},"supplierSku":{"type":"string","nullable":true},"packSize":{"type":"string","format":"decimal","nullable":true},"packUnit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/UnitRef"}]},"weightPerUnitG":{"type":"string","format":"decimal","nullable":true},"ingredientDeclaration":{"type":"string","nullable":true},"supplier":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"hasNutrition":{"type":"boolean","description":"Whether the offer has a current stored nutrition row."}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message."},"code":{"type":"string","description":"Stable machine-readable error code (e.g. INVALID_QUERY_PARAMETER, MISSING_PATH_PARAMETER, RESOURCE_NOT_FOUND, INTERNAL_ERROR)."},"parameter":{"type":"string","description":"The offending query or path parameter, when applicable."}}}},"responses":{"BadRequest":{"description":"A query or path parameter failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing, invalid, or expired authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token does not grant access to exactly one organisation, so no tenant can be resolved from it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No resource found for the given id in the caller's organisation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/apim/products/{productId}":{"get":{"operationId":"GetProduct","summary":"Get a product","description":"Returns one product (ingredient) with its stored allergen associations, stored nutrition, dietary suitability, ingredient declaration, category, tags, raw pack fields and up to 50 active supplier offers. Nutrition prefers the current `IngredientNutrition` row and falls back to the current `OfferNutrition` row of an active offer; `nutrition.source` says which was used. `packDisplay` is not returned — it is a calculated field that today only exists in `packages/graphql`, so the raw fields it is derived from are exposed under `pack` instead. Cost, GP and margin figures are deliberately excluded.","tags":["Products"],"parameters":[{"$ref":"#/components/parameters/ProductId"}],"responses":{"200":{"description":"The product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDetail"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hos.accessacloud.com/evo-recipes-api/products.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.