Skip to main content

​
Introduction

The Higg PM Claims Search API is a JSON query API. All parameters are sent as JSON. The API can be used to download the claims information from the product module claims library. This information can be used to search for eligible claims to send for verification/claims creation. And to search for claims that are soon to expire.
Note the product library claims information returned in this API endpoint is dynamically calculated based on the current information saved for the product. It may not match the information in the Claims library claims/profiles which is a snapshot of the claim information at the time the claim was approved. For example, if a user edits a product after a claim is approved, the product claims library will show the newest potential claim level based on the edited product, whereas the approved claim will still show the claim level achieved at the time of approval.

​
Search parameters

To return all product module library claims data in the account, remove all the search parameters and use {}. The following attributes can optionally be used to query the API. The products that meet all entered criteria will be returned.
See Transparency Claims Data Dictionary for details about each search parameter.
  • Product ID
  • Product Name
  • Style Number
  • Barcodes
  • Claim Type
  • Claim Status
  • Level / Score
  • Expires After
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. 
{
        "productIds": "6220046225ceb5000a839afc",
        "productName": "Test endpoint sondra",
        "status": "Eligible",
        "level": 2,
        "styleNumber": "1327341",
        "barcodes": ["1734321314","134314314"],
   			"expiresAfter": 1677801410179,
        "claimType": "Materials",  
        "from": 10,
   			"size": 3
    }

​
Search results

The following product module library claim information is returned in the results.
Note that there are currently two workflows supported for creating Materials claims. Users can create claims by using the Higg MSI/PM platform tools. 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 imported claims are flagged in the results with the field “importedMaterialsClaims”: true. These imported claims should be ignored in results since they already have verified claims and published profiles created during the import process.
{
        "productId": "721ac5cfb355000bd234a6",
        "productName": "Denim T-shirt",
        "claims": [
            {
                "status": "Created - Final",
                "level": "level 2",
                "expires": 1677801410179,
                "profileId": [
                    "CGRYUUG9"
                ],
                "claimType": "Materials"
            }
        ],
        "styleNumber": "1414314314",
        "barcodes": ["134134314","8224958194"],
        "importedMaterialsClaims": true,
        "productType": "Apparel",
        "productCategory": "Dress",
        "claimType": "Materials"
    },