Skip to main content

​
Introduction

Profiles are the webpage containers that hold claims. Each profile gets a webpage with the same id using format https://profiles.production.higg.com/profile/{profile id}. A profile in future can have multiple claims attached to it, though currently only one Higg Materials claim is associated with each profile. The claims profiles search API endpoint assists users with managing and exporting the profile information associated with the sustainability webpages on the Higg Sustainability Profiles website. The profile information can be used to generate scorecards on the users e-commerce website.

​
Search Parameters

To return all profiles in the account, remove all the search parameters and use {}. The following attributes can optionally be used to query the API. The profiles that meet all entered criteria will be returned.
See Transparency Data Dictionary for details about each search parameter. • Profile Created After
• Profile Created Before
• Profile modified After
• Profile modified Before To control the number of results returned and loop through the claims, you can use the from and size fields. The ‘from’ field tells the system which position to pull from. Note that the system starts at position 0. The ‘size’ determines how many claims to return. 
{
        "createdAfter": "2021-01-13T16:38:19.386Z",
        "createdBefore": "2021-01-13T16:38:19.386Z",
        "modifiedAfter": "2021-01-13T16:38:19.386Z",
        "modifiedBefore": "2021-01-13T16:38:19.386Z",
        "from": 10,
   			"size": 3
}

​
Profile Search Results

The following search results are returned that describe the status and metadata about the profile. Published profiles have a url. Visible = true, means the profile page is published on the website. 
{
        "accountId": "5dd466601e5f78000d7a69d7",
        "accountName": "Test account",
        "profileId": "PG9AYAQ9",
        "profilePageUrl": "https://profiles.higg.com/profile/PG9AYAQ9", 
        "brandName": "Acme Apparel",
        "claimOwnerPublicName": "Big Brands Retail",
        "created": "May 20, 2021",
        "modified": "May 20, 2021",
        "status": "Published",
  			"visible": true
}

​
Materials Claim Results

The Materials Claims profile results contain the information needed for users to communicate and display claims information on their e-commerce sites.
There are currently two workflows supported for creating Materials claims. Users can create claims by using the Higg MSI/PM platform tools, these claims are identified in the results as Claim Type “Materials” claims. Users can also fill out an offline data collection spreadsheet that is imported by Higg Admin into the Higg platform to generate Materials claims, these are identified in the results as Claim Type “Imported Materials”.
{
          "ClaimID":"XPRMYIA9",
          "claimType":"Materials",
	        "productId": "60a6d993000aaed3b4",
      	  "productStyleNumber": "BVDBN",
      	  "productName": "Striped T-Shirt",
       	 	"barcodes": [],
      		"levelAchievementClaim": 1,
        	"claimMaterials": "100% Cotton fabric, organic",
        	"conventionalMaterial": "100% Cotton fabric",
        	"msiVersion": "3.1.1",
        	"globalWarmingChange": "0.13632563926324637",
        	"FossilFuelsChange": "0.0882637485396021",
        	"waterUseChange": "0.879212169059786",
        	"waterPollutionChange": "0.4659069577464576",
        	"globalWarmingLevel": "1",
        	"fossilFuelsLevel": "0",
        	"waterUseLevel": "3",
        	"waterPollutionLevel": "2"
        }