Profiles
Profiles are the webpage containers that hold claims. Each profile gets a webpage with the same id using formathttps://profiles.production.higg.com/profile/{profile id}. A profile in future can have multiple claims attached to it, though currently only one Materials claim is associated with each profile.
| Field | Description | Type |
|---|---|---|
| profileId/Ids | profile Higg ID. This is unique Higg system identifier. Results return ‘profileId’, search parameters use ‘profilesIds’ to support multiple search ids. | STRING |
| accountId | Higg account ID | STRING |
| accountName | Higg account name | STRING |
| profilePageUrl | url for profile pages that have been published | url |
| brandName | optional user-entered brand name that is displayed on webpage | STRING |
| claimOwnerPublicName | optional user-entered company displaying name on their e-commerce site if different from brand name that is displayed on webpage | STRING |
| created | date the profile was created | ”May 20, 2021” |
| createdBefore | search parameter that returns profiles created before the search date | ”2021-01-13T16:38:19.386Z” |
| createdAfter | search parameter that returns profiles created after the search date | ”2021-01-13T16:38:19.386Z” |
| modified | date the profile was last edited | ”May 20, 2021” |
| modifiedBefore | search parameter that returns profiles edited before the search date | ”2021-01-13T16:38:19.386Z” |
| modifiedAfter | search parameter that returns profiles edited after the search date | ”2021-01-13T16:38:19.386Z” |
| status | ”Draft” means the profile is being edited, “Published” means the profile is saved as final and on the website | STRING |
| visible | True = “On Website” means the profile page is currently displayed on the Higg Sustainability website, False = “Off website” means the profile is not currently being displayed on the Higg Sustainability website | STRING |
Material Claims
Higg’s Transparency program currently supports the Higg Materials claim for products. The Materials claim provides consumer-facing impact information about product materials. You can learn more about Materials claims by going to the Higg Sustainability Profiles site.| Field | Description | Type |
|---|---|---|
| ClaimID | Higg claim ID. This is unique Higg system identifier. Results return ‘claimId’, search parameters use ‘claimIds’ to support multiple search ids. | STRING |
| claimType | ”Materials” are Materials claims created using the MSI/PM Higg platform interface. “Imported Materials” are Materials claims created using the offline claims data collection spreadsheet. | STRING |
| productId | product Higg ID. This is unique Higg system identifier. | STRING |
| productStyleNumber | product style/model number. | STRING |
| barcodes | Barcodes (UPC/EAN) / Retail Code | STRING |
| levelAchievementClaim | total product claim achievement level | FLOAT |
| claimMaterials | product bill of materials raw material stage | STRING |
| conventionalMaterial | the comparison conventional material | STRING |
| msiVersion | MSI taxonomy version at time claim was approved and created | STRING |
| globalWarmingChange | global warming % reduction compared to conventional material. Display as % reduction. | FLOAT |
| FossilFuelsChange | fossil fuel % reduction compared to conventional material. Display as % reduction. | FLOAT |
| waterUseChange | water use % reduction compared to conventional material. Display as % reduction. | FLOAT |
| waterPollutionChange | water pollution % reduction compared to conventional material. Display as % reduction. | FLOAT |
| globalWarmingLevel | global warming materials claim achievement level | FLOAT |
| FossilFuelsLevel | fossil fuel materials claim achievement level. | FLOAT |
| waterUseLevel | water use materials claim achievement level | FLOAT |
| waterPollutionLevel | water pollution materials claim achievement level | FLOAT |
Product Module Claims Library
This claims data is from the product material claims library and is NOT the final claim information. API users can access the product module claims information to manage claims prior to the claim being approved and the final claims/profiles being created the claims library.| Field | Description | Type |
|---|---|---|
| productId/Ids | product Higg ID. This is unique Higg system identifier. Results return ‘productId’, search parameters use ‘productIds’ to support multiple search ids. | STRING |
| productName | product name | STRING |
| productType | product type (Apparel, Footwear, Home Textiles, Other) | STRING |
| productCategory | product type category, options depend on the product type chosen) | STRING |
| styleNumber | 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 |
| type | claim type, eg Materials | STRING |
| status | claim status: “Ineligible”, “Eligible”, “In Verification”, “Created - Final” | STRING |
| level | potential claim score/level of product in product library. Note that this is a dynamic score for the product and due to changes to the product or underlying data, it may not match the level score that was saved on the final claim at time of claim approval. | FLOAT |
| expires | date approved claim expires | unix timestamp, 1629492077829 |
| profileId | id for profiles attached to the claim | STRING |
| ”Imported Materials” | true indicates that the product was created using the offline spreadsheet importer and that corresponding claims/profiles are already created for the product automatically as part of the spreadsheet import process | BOOLEAN |