Migrating from API v1

An overview of some of the changes when migration from v1 of the API

We have put together some information to help users moving from API v1 to v2. In particular we highlight some of the main differences to anticipate when making the switch.

Authentication

The API now uses simple API Tokens. See section on authentication.

New Endpoints for Wholesaler Catalogs

In the new API users are able to access products in a wholesalers catalog using the Wholesaler Catalog endpoints. This provides a much easier way to access product data quickly for a wholesaler. These endpoints also allow you access a product specification directly using the wholesaler's own product code.

Data Model Changes

The data model for Erudus has been expanded since v1 of the API. Please review the schema browser accessible from the API portal and the main Erudus application for the complete set of current fields, which are frequently being added to.

In v2 each product specification type (schema) can have a different set of fields depending on its value. Please use the schema browser for reference.

When updating a product you must supply the entire product in the payload. In v1 it was possible to update an inner component as a separate process. This is no longer supported.

The changes listed below are concerned with changes to field names and mappings, to assist with migrating existing integrations with v2 of the API.

Product level fields that have changed

Old Name	New/Equivalent Name	Notes
supplier_id	manufacturer
wholesaler_id	label
case_label_name	manufacturer_product_name
suppliers_product_code	manufacturer_product_code
wholesaler_code	label_code
food_drink_id	product_type
category_id	storage_type
generic_field_id	product_category
supplier_comments	manufacturer_comments
outer_case_length	outer_case_depth
unit_load_layer_items	outer_case_widthcases_per_pallet_layer
unit_load_layers	layers_per_pallet
traded_items_per_unit_load	cases_per_pallet
unit_load_height	pallet_height
unit_load_gross_weight	pallet_gross_weight
max_lifespan	max_shelf_life
is_multipack	---removed---
outer_packaging_plastic_weight	--removed---
outer_packaging_glass_weight	--removed---
outer_packaging_paper_weight	--removed---
outer_packaging_alu_weight	--removed---
outer_packaging_steel_weight	--removed---
outer_packaging_other_weight	--removed---
outer_recycled_plastic_percentage	--removed---
pmw_plastic	--removed---
pmw_paperboard	--removed---
pmw_wood	--removed---
transport_recycled_plastic_percentage	--removed---

Component level fields that have changed

Old Name	New/Equivelant Name	Notes
suppliers_component_code	manufacturers_component_code
inner_pack_length	inner_component_depth
inner_pack_depth	inner_component_height
inner_pack_width	inner_component_width
inner_product_weight	inner_component_weight inner_component_volume	This field has been split out into weight and volume fields.
inner_product_weight_units	inner_component_weight_unitsinner_component_volume_units
artifical_flavourings	artificial_flavourings
artifical_flavour_enhancers	artificial_flavour_enhancers
artifical_preservatives	artificial_preservatives
artifical_sweeteners	artificial_sweeteners
contains_alomond_nuts	contains_almond_nuts
contains_queensland_nuts	---removed---
contains_kamut	---removed---
contains_spelt	---removed---
allergen_statement	additional_allergen_information
halal_approved	halal_suitable
kosher_approved	kosher_suitable
serving	serving_size
fat_percentage_dry	fat_percentage_dry_100
non_milk_extrinsic_sugars_100g	non_milk_extrinsic_sugars_100
vitamin_a_100g	vitamin_a_100
vitamin_c_100g	vitamin_c_100
folate_100g	folate_100
sodium_100	sodium_100	Now in mg
calcium_100g	calcium_100
iron_100g	iron_100
zinc_100g	zinc_100
count_per_pack	count_per_inner_component
red_tractor	acc_red_tractor
fair_trade	acc_fair_trade
marine_stewardship	acc_msc
organic	acc_organic
brc_certified	acc_brcgs_certified
eec_number	health_marks
inner_packaging_glass_weight	---removed---
inner_packaging_plastic_weight	---removed---
inner_packaging_paper_weight	---removed---
inner_packaging_alu_weight	---removed---
inner_packaging_steel_weight	---removed---
inner_packaging_other_weight	---removed---
inner_recycled_plastic_percentage	---removed---
inner_packaging_type_id	---removed---
lactose_intolerance_suitable	---removed---