MSI Data Dictionary

The MSI Data Dictionary includes Metadata, Material and Processes, Yield, and Impacts.

Material/Trim/Package Metadata

Metadata about the results and material/trim/package.

Field	Description	Type
from	Position of result in the file. As a search parameter it sets the index the result starts from (eg start with position 50). Note that 0 is the first position. This is optional and default is zero.	DOUBLE
size	Pagination of result. As a search parameter you can use it to limit the number of returned results. This is optional and default is zero.	DOUBLE
total	How many results are returned	DOUBLE
id/ids	Material/Trim/Package Higg ID. This is unique Higg system identifier. Results return ‘id’, search parameters use ‘ids’ to support multiple search ids. Note that for example materials where (sample = true), ‘id’ and ‘code’ are the same.	STRING
text/name	Material/Trim/Package name. Search parameters use ‘text’, results return ‘name’, update uses ‘name’.	STRING
type	material, trim, packaging	STRING
sample	Base/Example materials (true), Custom materials (false)	BOOLEAN
draft	Draft status (true), Final status (false).	BOOLEAN
code	Material code. For Example materials (sample = true) this is the code entered by Higg admin that also matches the ‘id’. For Custom materials (sample = false) this is the optional text entered by user. Searching supports searching on multiple codes.	STRING
partNumber	Trim part number (entered by user)	STRING
productNumber	Packaging product number (entered by user)	STRING
description	Material/Trim/Package description	STRING
created	Result for date material/trim/package was created	unix timestamp, 1629492077829
lastEdited	Result for date material/trim/package was last edited.	unix timestamp, 1629492077829
createdAfter	Search for materials created after date	”2021-01-13T16:38:19.386Z”
createdBefore	Search for materials created before date	”2021-01-13T16:38:19.386Z”
lastEditedAfter	Search for materials last edited after date	”2021-01-13T16:38:19.386Z”
lastEditedBefore	Search for materials last edited before date	”2021-01-13T16:38:19.386Z”
userEmail	email identifying who created the material	STRING
platformModifiedBy	Indicates if user (“user”) or API (“Api”) updated the material. Note only products created after the API went live Sep 1, 2021 have this flag set	STRING
platformCreatedBy	Indicates if user (“user”) or API (Api”) created the material. Note only products created after the API went live Sep 1, 2021 have this flag set	STRING
sharedBy	Account name that shared the acquired material	STRING
vendor	Trim/Package Vendor	STRING

Impacts

MSI API includes both Higg MSI normalized scores and Life Cycle Impact Assessment (LCIA) absolute values. E

Field	Description	Type
globalWarmingPts	Global Warming MSI Score	DOUBLE
eutrophicationPts	Eutrophication MSI Score	DOUBLE
waterScarcityPts	Water Scarcity MSI Score	DOUBLE
abioticDepletionPts	Abiotic Resource Depletion, Fossil Fuels MSI Score	DOUBLE
chemistryPts	Chemistry MSI Score	DOUBLE
globalWarming	Global Warming LCIA value (kg CO2 eq)	DOUBLE
eutrophication	Eutrophication LCIA value (kg PO4– eq)	DOUBLE
waterScarcity	Water Scarcity LCIA value (m3)	DOUBLE
abioticDepletion	Abiotic Resource Depletion, Fossil Fuels LCIA value (MJ eq)	DOUBLE
chemistry	Chemistry LCIA value (units)	DOUBLE
biogenicCarbon	Biogenic Carbon Content LCIA value (kg CO2 eq) (Not included in MSI score)	DOUBLE
waterConsumption	Water Consumption LCIA value (liters) (Not included in MSI score)	DOUBLE
impact	MSI score total (The MSI single score total was retired January 2021. No data will be returned for ‘impact’.)	DOUBLE

Field	Description	Type
category	Returned at the end of a custom material result, it is the user-defined material type. Returned as part of the baseMaterials result it is the system defined category for the base material.	STRING

Base/Example Materials

Base materials (which are also the Example Materials) are the top-level type of material. Base Materials are then customized by process cycles/stages (eg cycles/stages are raw material stage, textile formation, dying etc). You can access a list of the Base Materials, Base Material IDs, and which material category they are part of, by going to:
GET https://api-v2.production.higg.org/msi-api/base-materials You can retrieve the Base Materials and their impacts by using the MSI search and setting it to “sample”:true (ie searching for the list of example materials).
https://api-v2.production.higg.org/msi-api/search
Body: {“sample”: “true”}

Field	Description	Type
baseMaterials: id	Higg system id for the base material (note this is also the example material id/code	STRING
baseMaterials: _rev	Revision number	STRING
baseMaterials: name	Name of the base material/example material	STRING
baseMaterials: type	Identifies it as a “BaseMaterial”	STRING
baseMaterials: cod”	Higg system id for the base material (note this is also the example material id/code	STRING
baseMaterials: category	system-defined material type for the base material	STRING

Cycles/Stages/Processes

Cycles are the process stages users select to customize materials. The available processes are provided as well as the process the user selected. Some stages support multiple process selections. The base material uses the default raw material cycle/stage process (for example cotton, fabric can be the base material). The raw material cycle/stage process for the base material can be changed via the API using the processId. For example, changing default ‘cotton, fabric’ to ‘cotton fiber, organic”. The processes must be available for the base material in order to select them. The user can also change additional processes manually in the Higg MSI tool. The impacts for the process are also provided. To view the list of available processes for a base material via API use:
GET https://api-v2.production.higg.org/msi-api/materials/process-by-material/{base material Id}

Field	Description	Type
cycles	System id for the cycle/stage	STRING
processes	Available processes for the base material	STRING
selected: id	The process the user selected. Note some baseMaterials support multiple processes.	STRING
stageName	Returns the human-readable cycle/stage names to assist with understanding the API.	STRING
detailProcesses: name, id	Returns the process names and ids to assist working with the API.	STRING

Blends

Blends are custom materials made up of more than one material. For example an 80% cotton/20% polyester fabric. Note that this is material composition (ie the final material is a blend), not product composition (bill of materials). Product amounts for bill of materials are set in Product Module API.

Field	Description	Type
blendPercentage	Percent of the component material in the blend.	DOUBLE

Yield

Yield is user-defined conversion of the MSI 1kg material to a volume/linear uint. The yield can be set via the API. To view the list of available yield options via API use:
GET https://api-v2.production.higg.org/msi-api/yields

Field	Description	Type
type	yield type, eg ” “Yards (volumetric)“	STRING
width	width amount	DOUBLE
widthUnit	width unit of measure	STRING
thickness	thickness amount	DOUBLE
thicknessUnit	thickness amount unit of measure	STRING
densityVolumetric	density amount. Volume yields use densityVolumetric.	DOUBLE
densityVolumetricUnit	density unit of measure. Volume yields use densityVolumetric.	STRING
densityLinear	density amount. Linear yields use densityLinear	DOUBLE
densityLinearUnit	density unit of measure. Linear yields use densityLinear	STRING
conversion	Conversion of yield to 1kg of material. The conversion number can be used to perform conversions within the integrated system.	DOUBLE

Getting Started

Data Dictionaries

Material/Trim/Package Metadata

Impacts

Category

Base/Example Materials

Cycles/Stages/Processes

Blends

Yield

​Material/Trim/Package Metadata

​Impacts

​Category

​Base/Example Materials

​Cycles/Stages/Processes

​Blends

​Yield

Material/Trim/Package Metadata

Impacts

Category

Base/Example Materials

Cycles/Stages/Processes

Blends

Yield