Choosing between the RME Import and Export APIs

The RME Import and Export APIs provide a wide range of functionality, with some overlap between the two for retrieving information (GET requests).

The Export API was the first RME API developed and allows only GET requests. This API supports customers as well as partners to retrieve detailed information from Fourth.

The Import API supports a wider range of API methods — GET, POST and DELETE — which among other things enables integrators to add and update recipe, ingredient and supplier details. New development is focused primarily on this API; however, as noted below, the Export API may still be the preferable way to retrieve information.

The below sections explain the best endpoints for retrieving the data you need.

Ingredients

Data API Endpoints

Core data about ingredients

Export

The Export endpoints contains more base ingredient information, such as its categories. It also provides useful information relevant to customers that create Choice and Option recipes.

Get details for one ingredient: /ingredients/{guid}

Get details for all ingredients: /ingredients

Import

The Import endpoint is focused more on data that is relevant to customers also using Fourth Inventory.

Get ingredients:  /ingredients

Alternate ingredients Import

Get details of alternate ingredients for an ingredient:  /ingredientsalternates

Get summary of alternates for ingredients:  /ingredientalternates

Price bands Import

Get price bands for ingredients: /ingredientspricebands

Ingredient's ingredient list for the FIR 2019 (Natasha's Law) Import

Get ingredient lists: /ingredientlist

See also Support for Natasha's Law.

Ingredient list history
(Natasha's Law)
Export

Get audit history of ingredient list for one ingredient:  /Ingredients/{guid}/fullIngredientListHistory

Get audit history of ingredient lists for ingredients:  /Ingredients/fullIngredientListHistory

Shelf life Import

Get ingredient shelf life:  /ingredientshelflife

Nutrition Export

Get nutrient data for an ingredient:  /ingredients/{guid}/nutrition

Allergens / Intolerances Export

Get intolerances for an ingredient:  /ingredients/{guid}/intolerances

Get audit history for all ingredient intolerances:  /Ingredients/intolerancehistory

Get audit history for one ingredient's intolerances:  /Ingredients/{guid}/intolerancehistory

Images Export

Get pictures for an ingredient:  /Ingredients/{guid}/pictures

Food processing data Export

Get food processing data for an ingredient: /Ingredients/{guid}/processdata

Supplier specification Export

Get supplier's specification for an ingredient: /Ingredients/{guid}/supplierspec

Recipes

Data API Endpoints
Core data about recipes Export

Get details for all recipes: /Recipes

Get details for one recipe: /Recipes/{guid}

Names Import

Get recipe names: /recipenames

Identifiers Import

Get recipe identifiers: /recipeIdentifiers

Preparation steps Import

Get recipe preparation steps: /recipeprepsteps

Preparation services Import

Get service preparation for recipe: /recipeprepservices

Images Export

Get pictures for a recipe: /Recipes/{guid}/pictures

Recipe's ingredient list for the FIR 2019 (Natasha's Law) Import

Get full ingredient list for recipe: /recipeingredientlist

See also Support for Natasha's Law.

Ingredient list history
(Natasha's Law)
Export

Get audit history of ingredient list for one recipe: /Recipes/{guid}/fullIngredientListHistory

Get audit history of ingredient lists for all recipes: /Recipes/fullIngredientListHistory

Nutrition Export

Get nutrient data for a recipe: /Recipes/{guid}/nutrition

Allergens / Intolerances Export

Get intolerances for a recipe: /Recipes/{guid}/intolerances

Intolerance history Export

Get audit history for one recipe's intolerances: /Recipes/{guid}/intolerancehistory

Get audit history for all recipe intolerances: /Recipes/intolerancehistory

Menus

Data API Endpoint
Core data about menus Export

Get all menus: /menus

Get a menu: /menus/{guid}

Suppliers

Data API Endpoints
Core data about suppliers Import

Get suppliers: /suppliers

Group supplier Import

Get suppliers in each group: /groupSuppliers

Lists

Data API Endpoints
Categories Import

Get all categories: /categories

Nutrient list Export

Get generic list of nutrients: /nutrients

Intolerance list Export

Get food intolerances across the business: /intolerances