PM Data Dictionary

The PM Data Dictionary includes metadata, impacts, and additional product details Below is a dictionary of the most commonly used product module attributes to help with common operations. For indicators outside of this list, please contact Higg for more information.

Product Metadata

Metadata about the product.

Field	Description	Type
id/ids	product Higg ID. This is unique Higg system identifier. Results return ‘id’, search parameters use ‘ids’ to support multiple search ids.	STRING
name	product name	STRING
productType	product type (Apparel, Footwear, Home Textiles, Other)	STRING
productCategory	product type category, options depend on the product type chosen)	STRING
productStyleNumber / modelNumber	product style/model number. Use productStyleNumber to search, results return modelNumber. This field can be used to store PLM id, but note that the user can manually edit field in the Product Module tool interface.	STRING
barcodes	Barcodes (UPC/EAN) / Retail Code	STRING
user:id	user who created product account id	STRING
user:email	user who created product	STRING
account: id	Higg system account id	STRING
account: name	Name of the account	STRING
account: country	Company account country	STRING
account: higgID/sacId	This is the account ID. To search use higgID, results return sacID	STRING
account: demoaccount	Account is set as demo account for testing, Demo (true)/Not Demo (False)	BOOLEAN
created	Result for date product was created	unix timestamp, 1629492077829
lastEdited	Result for date product was last edited.	unix timestamp, 1629492077829
createdAfter	Search for products created after date	”2021-01-13T16:38:19.386Z”
createdBefore	Search for products created before date	”2021-01-13T16:38:19.386Z”
lastEditedAfter	Search for products last edited after date	”2021-01-13T16:38:19.386Z”
lastEditedBefore	Search for products last edited before date	”2021-01-13T16:38:19.386Z”
userEmail	email identifying who created the material	STRING
platformCreatedBy	who created the product (API, User). Note only products created after the API went live Sep 1, 2021 have this flag set.	STRING
platformModifiedBy	who last modified the product (API, User). Note only products created after the API went live Sep 1, 2021 have this flag set.	STRING
draft	Product status, Draft (true)/Final	BOOLEAN
productNetWeight	The total product net weight	DOUBLE
bomNetWeight	The product bill of materials net weight	DOUBLE
grossWeight	The product gross weight	DOUBLE

Product Bill of Materials

When creating products, the material/trim/packaging amounts and units of measure must be supplied. Part name is optional.

Field	Description	Type
partName	Optional user-defined name for the part	STRING
amount	amount of the material/trim/packaging in the product	DOUBLE
measureUnit	Trim and packaging this is “units”. Following units are available for base and custom materials: “kilograms”, “grams”, “milligram”, “pound”, “ounce”. If material has yield in MSI it is available as option.	STRING

Product Impacts

The PM API search results return the total product impacts per use and absolute. “totalPerUseImpacts” are the total product per use impacts.
”scores” are the absolute total product impacts.
”scoresTotalAltProductCare” are the absolute total product impacts using alternative product care. Note these are to help inform brands internally and should not be communicated externally to consumer or other businesses.

Field	Description	Type
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)	DOUBLE
waterConsumption	Water Consumption LCIA value (liters)	DOUBLE

Stage Impacts

The PM API search results returns stage-level impacts per use and absolute. Absolute stage-level impacts

Field	Description
billOfMaterialScores	Bill of materials impacts
finishedGoodsScores	Finished Goods Manufacturing impacts
packagingImpacts	External packaging not included in BoM impacts
logisticsImpacts	Logistics impacts
retailImpacts	Distribution center and retail impacts
productCareImpacts	Standard product care impacts
endOfUseImpacts	End of use impacts

Per use stage-level impacts

Field	Description
bomPerUseImpacts	Bill of materials impacts
finishedPerUseImpacts	Finished Goods Manufacturing impacts
packagingPerUseImpacts	External packaging not included in BoM impacts
logisticsPerUseImpacts	Logistics impacts
retailPerUseImpacts	Distribution center and retail impacts
productCarePerUseImpacts	Standard product care impacts
endOfUsePerUseImpacts	End of use impacts

Certifications

Higg Product Module supports a limited selection of third-party certifications to attach to products. Accounts with certifications enabled have the ability to search, update, and create certifications using the PM API. If you are interested in turning certifications on for your account, please contact Higg for details.

Field	Description	Type
id	This is the Higg system certificate identifier	STRING
assertionAuthorityName	List of supported certification authorizing bodies. For example, TextileExchange	ID
assertionAuthorityId	The ID for the assertionAuthorityName	DOUBLE
assertionStandardName	List of supported certification types. For example, Content Claim Standard (CCS)	ID
assertionStandardId	The ID for the assertionStandardName	DOUBLE
assertionId	The certificate id the user enters, usually found on the certificate	STRING
certificateName, certificationName	The name of the certificate the user enteres, usually found on the certificate	STRING
proofBody	The Certifying / Issuing Body	STRING
dateIssued	The date the certificate was issued	unix timestamp, 1629492077829
dateExpires	The date the certificate expires	unix timestamp, 1629492077829
certificationFiles	File images of the certificate	Base64
productModuleIds	Higg product ids to attach to a certificate when creating via API	STRING
addNewProducts	adds products to existing certs	STRING
removeProducts	removes relationship between products and certs	STRING

Additional Product Details

Additional details about the product that the user can set manually in the Product Tool are also available via the API including Bill of Materials composition and individual material impacts, Finished Goods Processes, Manufacturing waste disposal, packaging, logistics mode of transport and distances, and distribution center and retail impacts. If you are interested in integrating this additional product information into your system, please contact Higg for details.

Getting Started

Data Dictionaries

Product Metadata

Product Bill of Materials

Product Impacts

Stage Impacts

Certifications

Additional Product Details

​Product Metadata

​Product Bill of Materials

​Product Impacts

​Stage Impacts

​Certifications

​Additional Product Details

Product Metadata

Product Bill of Materials

Product Impacts

Stage Impacts

Certifications

Additional Product Details