Skip to main content
POST
/
higg-index
/
pm
/
search
Search Pm
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "accountId": "<string>",
  "certifications": [
    "<string>"
  ],
  "claimsStatus": "<string>",
  "claimsLevel": 123,
  "claimsExpires": "<string>",
  "higgId": 123,
  "name": "<string>",
  "productStyleNumber": "<string>",
  "productCategory": {},
  "createdAfter": "2023-11-07T05:31:56Z",
  "createdBefore": "2023-11-07T05:31:56Z",
  "lastEditedAfter": "2023-11-07T05:31:56Z",
  "lastEditedBefore": "2023-11-07T05:31:56Z",
  "productLastEditedBefore": "2023-11-07T05:31:56Z",
  "productLastEditedAfter": "2023-11-07T05:31:56Z",
  "submittedBefore": "2023-11-07T05:31:56Z",
  "submittedAfter": "2023-11-07T05:31:56Z",
  "barcodes": [
    "<string>"
  ],
  "from": 123,
  "size": 123
}
'
import requests

url = "https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search"

payload = {
    "ids": ["<string>"],
    "accountId": "<string>",
    "certifications": ["<string>"],
    "claimsStatus": "<string>",
    "claimsLevel": 123,
    "claimsExpires": "<string>",
    "higgId": 123,
    "name": "<string>",
    "productStyleNumber": "<string>",
    "productCategory": {},
    "createdAfter": "2023-11-07T05:31:56Z",
    "createdBefore": "2023-11-07T05:31:56Z",
    "lastEditedAfter": "2023-11-07T05:31:56Z",
    "lastEditedBefore": "2023-11-07T05:31:56Z",
    "productLastEditedBefore": "2023-11-07T05:31:56Z",
    "productLastEditedAfter": "2023-11-07T05:31:56Z",
    "submittedBefore": "2023-11-07T05:31:56Z",
    "submittedAfter": "2023-11-07T05:31:56Z",
    "barcodes": ["<string>"],
    "from": 123,
    "size": 123
}
headers = {
    "x-api-key": "<api-key>",
    "x-developer-request-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-developer-request-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ids: ['<string>'],
    accountId: '<string>',
    certifications: ['<string>'],
    claimsStatus: '<string>',
    claimsLevel: 123,
    claimsExpires: '<string>',
    higgId: 123,
    name: '<string>',
    productStyleNumber: '<string>',
    productCategory: {},
    createdAfter: '2023-11-07T05:31:56Z',
    createdBefore: '2023-11-07T05:31:56Z',
    lastEditedAfter: '2023-11-07T05:31:56Z',
    lastEditedBefore: '2023-11-07T05:31:56Z',
    productLastEditedBefore: '2023-11-07T05:31:56Z',
    productLastEditedAfter: '2023-11-07T05:31:56Z',
    submittedBefore: '2023-11-07T05:31:56Z',
    submittedAfter: '2023-11-07T05:31:56Z',
    barcodes: ['<string>'],
    from: 123,
    size: 123
  })
};

fetch('https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ids' => [
        '<string>'
    ],
    'accountId' => '<string>',
    'certifications' => [
        '<string>'
    ],
    'claimsStatus' => '<string>',
    'claimsLevel' => 123,
    'claimsExpires' => '<string>',
    'higgId' => 123,
    'name' => '<string>',
    'productStyleNumber' => '<string>',
    'productCategory' => [
        
    ],
    'createdAfter' => '2023-11-07T05:31:56Z',
    'createdBefore' => '2023-11-07T05:31:56Z',
    'lastEditedAfter' => '2023-11-07T05:31:56Z',
    'lastEditedBefore' => '2023-11-07T05:31:56Z',
    'productLastEditedBefore' => '2023-11-07T05:31:56Z',
    'productLastEditedAfter' => '2023-11-07T05:31:56Z',
    'submittedBefore' => '2023-11-07T05:31:56Z',
    'submittedAfter' => '2023-11-07T05:31:56Z',
    'barcodes' => [
        '<string>'
    ],
    'from' => 123,
    'size' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-developer-request-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"accountId\": \"<string>\",\n  \"certifications\": [\n    \"<string>\"\n  ],\n  \"claimsStatus\": \"<string>\",\n  \"claimsLevel\": 123,\n  \"claimsExpires\": \"<string>\",\n  \"higgId\": 123,\n  \"name\": \"<string>\",\n  \"productStyleNumber\": \"<string>\",\n  \"productCategory\": {},\n  \"createdAfter\": \"2023-11-07T05:31:56Z\",\n  \"createdBefore\": \"2023-11-07T05:31:56Z\",\n  \"lastEditedAfter\": \"2023-11-07T05:31:56Z\",\n  \"lastEditedBefore\": \"2023-11-07T05:31:56Z\",\n  \"productLastEditedBefore\": \"2023-11-07T05:31:56Z\",\n  \"productLastEditedAfter\": \"2023-11-07T05:31:56Z\",\n  \"submittedBefore\": \"2023-11-07T05:31:56Z\",\n  \"submittedAfter\": \"2023-11-07T05:31:56Z\",\n  \"barcodes\": [\n    \"<string>\"\n  ],\n  \"from\": 123,\n  \"size\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-developer-request-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search")
  .header("x-api-key", "<api-key>")
  .header("x-developer-request-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"accountId\": \"<string>\",\n  \"certifications\": [\n    \"<string>\"\n  ],\n  \"claimsStatus\": \"<string>\",\n  \"claimsLevel\": 123,\n  \"claimsExpires\": \"<string>\",\n  \"higgId\": 123,\n  \"name\": \"<string>\",\n  \"productStyleNumber\": \"<string>\",\n  \"productCategory\": {},\n  \"createdAfter\": \"2023-11-07T05:31:56Z\",\n  \"createdBefore\": \"2023-11-07T05:31:56Z\",\n  \"lastEditedAfter\": \"2023-11-07T05:31:56Z\",\n  \"lastEditedBefore\": \"2023-11-07T05:31:56Z\",\n  \"productLastEditedBefore\": \"2023-11-07T05:31:56Z\",\n  \"productLastEditedAfter\": \"2023-11-07T05:31:56Z\",\n  \"submittedBefore\": \"2023-11-07T05:31:56Z\",\n  \"submittedAfter\": \"2023-11-07T05:31:56Z\",\n  \"barcodes\": [\n    \"<string>\"\n  ],\n  \"from\": 123,\n  \"size\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"accountId\": \"<string>\",\n  \"certifications\": [\n    \"<string>\"\n  ],\n  \"claimsStatus\": \"<string>\",\n  \"claimsLevel\": 123,\n  \"claimsExpires\": \"<string>\",\n  \"higgId\": 123,\n  \"name\": \"<string>\",\n  \"productStyleNumber\": \"<string>\",\n  \"productCategory\": {},\n  \"createdAfter\": \"2023-11-07T05:31:56Z\",\n  \"createdBefore\": \"2023-11-07T05:31:56Z\",\n  \"lastEditedAfter\": \"2023-11-07T05:31:56Z\",\n  \"lastEditedBefore\": \"2023-11-07T05:31:56Z\",\n  \"productLastEditedBefore\": \"2023-11-07T05:31:56Z\",\n  \"productLastEditedAfter\": \"2023-11-07T05:31:56Z\",\n  \"submittedBefore\": \"2023-11-07T05:31:56Z\",\n  \"submittedAfter\": \"2023-11-07T05:31:56Z\",\n  \"barcodes\": [\n    \"<string>\"\n  ],\n  \"from\": 123,\n  \"size\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "_id": "<string>",
      "created_on": 123,
      "name": "<string>",
      "productCategory": {},
      "userEmail": "<string>",
      "draft": true,
      "grossWeight": 123,
      "last_edit": 123,
      "modelNumber": "<string>",
      "barcodes": [
        "<string>"
      ],
      "productNetWeight": 123,
      "bomNetWeight": 123
    }
  ]
}
Use this endpoint to search your Higg Product Module (PM) entries. Product Module objects contain detailed product-level sustainability data and can be referenced when creating PIC products.

​
Request body params

NameTypeDescription
namestringFilter PM entries by name.
idsArray<string>Filter by specific PM IDs.
fromnumber[DEFAULT: 0] Pagination start index.
sizenumber[DEFAULT: 50] Number of results to return.

​
Implementation Details

  • Published only: Only non-draft Product Module entries are returned.
  • Pagination: Standard pagination using from and size with a default of 50 results.
  • Additional filters: The full request schema supports additional filter parameters beyond those listed above (e.g., certifications, productType, date ranges). See the API playground for the complete schema.

Authorizations

​
x-api-key
string
header
required
​
x-developer-request-token
string
header
required

Body

application/json

MSI & PM Search requests

​
ids
string[] | null
​
accountId
string | null
​
certifications
string[] | null
​
claimsStatus
string | null
​
claimsLevel
number<double> | null
​
claimsExpires
string | null
​
higgId
number<double> | null
​
name
string | null
​
productStyleNumber
string | null
​
productType
enum<string>
Available options:
Apparel,
Footwear,
HomeTextiles,
Other
​
productCategory
object | null
​
createdAfter
string<date-time> | null
​
createdBefore
string<date-time> | null
​
lastEditedAfter
string<date-time> | null
​
lastEditedBefore
string<date-time> | null
​
platformModifiedBy
enum<string>
Available options:
User,
Api
​
platformCreatedBy
enum<string>
Available options:
User,
Api
​
productLastEditedBefore
string<date-time> | null
​
productLastEditedAfter
string<date-time> | null
​
submittedBefore
string<date-time> | null
​
submittedAfter
string<date-time> | null
​
barcodes
string[] | null
​
claimType
enum<string>
Available options:
Materials,
Disclosure
​
from
number<double> | null
​
size
number<double> | null

Response

200 - application/json

Ok

API Search responses

​
from
number<double>
required
​
size
number<double>
required
​
total
number<double>
required
​
results
object[]
required