curl --request POST \
--url https://api-v2.production.higg.org/pic-api/v1/products/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-developer-request-token: <api-key>' \
--data '
{
"id": [
"<string>"
],
"name": [
"<string>"
],
"textSearch": [
"<string>"
],
"from": 123,
"size": 123,
"productSize": [
"<string>"
],
"productCategory": [
"<string>"
],
"component": [
"<string>"
],
"material": [
"<string>"
],
"packaging": [
"<string>"
],
"tag": [
"<string>"
],
"identifier": [
"<string>"
],
"hasFrenchEcoScore": true
}
'{
"from": 123,
"size": 123,
"total": 123,
"results": [
{
"_id": "<string>",
"name": "<string>",
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"type": "<string>",
"createdOn": {},
"user": {
"_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"account": {
"_id": "<string>",
"name": "<string>",
"country": "<string>",
"sacId": 123,
"oar_id": "<string>",
"demoaccount": true,
"vbType": "None",
"socialCreditId": "<string>",
"taxId": "<string>",
"bluesignId": "<string>",
"zdhcId": "<string>",
"ipeViolation": {
"totalViolations": 123
},
"ffcId": 123,
"approvalStatus": "Approved"
},
"materials": [
{
"name": "<string>",
"netUse": 123,
"materialId": "<string>",
"composition": 123,
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"netWeight": 123
},
"isMsiMaterial": true,
"isPicMaterialLibrary": true,
"code": "<string>",
"dataSource": "<string>",
"isOutdated": true,
"description": "<string>",
"impacts": {
"tier4Impact": 123,
"tier2and3Impact": 123,
"totalMaterialLibrary": 123,
"totalTierImpact": 123,
"uncertainty": {
"lower": 123,
"upper": 123
}
}
}
],
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"_rev": "<string>",
"version": "<string>",
"productType": "<string>",
"productCategory": "<string>",
"packagingWeight": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"modelNumber": "<string>",
"barcodes": [
"<string>"
],
"dataSource": "<string>",
"modifiedOn": {},
"deleted": true,
"modifiedBy": {
"_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"deletedBy": {
"_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"defaultProduct": {
"defaultProductId": "<string>",
"name": "<string>"
},
"components": [
{
"name": "<string>",
"componentId": "<string>",
"unit": 123,
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"isMsiComponent": true,
"isOutdated": true,
"dataSource": "<string>",
"description": "<string>",
"impacts": {
"tier4Impact": 123,
"tier2and3Impact": 123,
"totalMaterialLibrary": 123,
"totalTierImpact": 123,
"uncertainty": {
"lower": 123,
"upper": 123
}
}
}
],
"packaging": [
{
"packagingId": "<string>",
"amount": 123,
"name": "<string>",
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"isMsiPackaging": true,
"isOutdated": true,
"code": "<string>",
"dataSource": "<string>",
"description": "<string>",
"impacts": {
"tier4Impact": 123,
"tier2and3Impact": 123,
"totalMaterialLibrary": 123,
"totalTierImpact": 123,
"uncertainty": {
"lower": 123,
"upper": 123
}
}
}
],
"notes": "<string>",
"purchaseOrder": [
{
"_id": "<string>",
"assembly": {
"isDefault": true,
"femId": "<string>",
"facilityName": "<string>",
"finalAssemblyRawText": "<string>",
"surveyVersion": "<string>",
"finalAssemblyImpacts": 123,
"printingProductDyeingImpacts": 123,
"totalNormalizedImpacts": 123,
"sipfacilitytype": [
"<string>"
],
"annualProd": "<string>",
"country": "<string>",
"femDescriptor": "<string>",
"year": 123,
"assessmentStatus": "NS"
},
"purchaseOrderId": "<string>",
"purchaseDate": 123,
"impactPerUnit": 123,
"totalImpactPerUnit": 123,
"pmVersion": "<string>",
"msiVersion": "<string>",
"version": "<string>",
"amountPurchase": 123,
"isOutdated": true,
"impactsPerUnitMultiPack": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"totalImpactsMultiPack": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"impactsPerUnit": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"totalImpacts": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
}
}
],
"purchaseOrderImpactsTotal": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"componentImpact": 123,
"upstreamTransportation": 123,
"downstreamTransportationRetail": 123,
"downstreamTransportationConsumer": 123,
"distributionCenterUnOwned": 123,
"retailEnergyUnOwned": 123,
"frenchLabelManufacturingCountry": {
"code": "<string>",
"name": "<string>"
},
"frenchLabelFabricCountry": {
"code": "<string>",
"name": "<string>"
},
"frenchLabelDyeingCountry": {
"code": "<string>",
"name": "<string>"
},
"frenchLabelOptionalFields": {
"countrySpinning": {
"code": "<string>",
"name": "<string>"
},
"upcycled": true,
"price": 123,
"numberOfReferences": 123,
"business": "small-business"
},
"frenchLabelEligibility": {
"eligible": true,
"reasons": [
{
"category": "ProductType",
"message": "<string>"
}
]
},
"frenchLabelEcoScore": {
"score": 123,
"impacts": {
"acd": 123,
"cch": 123,
"etf": 123,
"etfC": 123,
"fru": 123,
"fwe": 123,
"htc": 123,
"htcC": 123,
"htn": 123,
"htnC": 123,
"ior": 123,
"ldu": 123,
"mru": 123,
"ozd": 123,
"pco": 123,
"pma": 123,
"swe": 123,
"tre": 123,
"wtu": 123,
"ecs": 123,
"pef": 123
},
"createdAt": 123,
"updatedAt": 123,
"impactsPercentageContribution": {
"acd": 123,
"cch": 123,
"etf": 123,
"etfC": 123,
"fru": 123,
"fwe": 123,
"htc": 123,
"htcC": 123,
"htn": 123,
"htnC": 123,
"ior": 123,
"ldu": 123,
"mru": 123,
"ozd": 123,
"pco": 123,
"pma": 123,
"swe": 123,
"tre": 123,
"wtu": 123,
"ecs": 123,
"pef": 123
},
"status": "Pending",
"apiVersion": "<string>",
"apiResponseError": "<string>"
}
}
]
}Searches for products based on various criteria.
curl --request POST \
--url https://api-v2.production.higg.org/pic-api/v1/products/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-developer-request-token: <api-key>' \
--data '
{
"id": [
"<string>"
],
"name": [
"<string>"
],
"textSearch": [
"<string>"
],
"from": 123,
"size": 123,
"productSize": [
"<string>"
],
"productCategory": [
"<string>"
],
"component": [
"<string>"
],
"material": [
"<string>"
],
"packaging": [
"<string>"
],
"tag": [
"<string>"
],
"identifier": [
"<string>"
],
"hasFrenchEcoScore": true
}
'{
"from": 123,
"size": 123,
"total": 123,
"results": [
{
"_id": "<string>",
"name": "<string>",
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"type": "<string>",
"createdOn": {},
"user": {
"_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"account": {
"_id": "<string>",
"name": "<string>",
"country": "<string>",
"sacId": 123,
"oar_id": "<string>",
"demoaccount": true,
"vbType": "None",
"socialCreditId": "<string>",
"taxId": "<string>",
"bluesignId": "<string>",
"zdhcId": "<string>",
"ipeViolation": {
"totalViolations": 123
},
"ffcId": 123,
"approvalStatus": "Approved"
},
"materials": [
{
"name": "<string>",
"netUse": 123,
"materialId": "<string>",
"composition": 123,
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"netWeight": 123
},
"isMsiMaterial": true,
"isPicMaterialLibrary": true,
"code": "<string>",
"dataSource": "<string>",
"isOutdated": true,
"description": "<string>",
"impacts": {
"tier4Impact": 123,
"tier2and3Impact": 123,
"totalMaterialLibrary": 123,
"totalTierImpact": 123,
"uncertainty": {
"lower": 123,
"upper": 123
}
}
}
],
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"_rev": "<string>",
"version": "<string>",
"productType": "<string>",
"productCategory": "<string>",
"packagingWeight": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"modelNumber": "<string>",
"barcodes": [
"<string>"
],
"dataSource": "<string>",
"modifiedOn": {},
"deleted": true,
"modifiedBy": {
"_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"deletedBy": {
"_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>"
},
"defaultProduct": {
"defaultProductId": "<string>",
"name": "<string>"
},
"components": [
{
"name": "<string>",
"componentId": "<string>",
"unit": 123,
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"isMsiComponent": true,
"isOutdated": true,
"dataSource": "<string>",
"description": "<string>",
"impacts": {
"tier4Impact": 123,
"tier2and3Impact": 123,
"totalMaterialLibrary": 123,
"totalTierImpact": 123,
"uncertainty": {
"lower": 123,
"upper": 123
}
}
}
],
"packaging": [
{
"packagingId": "<string>",
"amount": 123,
"name": "<string>",
"weightInformation": {
"convertedToKg": 123,
"weight": 123,
"unit": "kilograms",
"isPrimaryData": true
},
"isMsiPackaging": true,
"isOutdated": true,
"code": "<string>",
"dataSource": "<string>",
"description": "<string>",
"impacts": {
"tier4Impact": 123,
"tier2and3Impact": 123,
"totalMaterialLibrary": 123,
"totalTierImpact": 123,
"uncertainty": {
"lower": 123,
"upper": 123
}
}
}
],
"notes": "<string>",
"purchaseOrder": [
{
"_id": "<string>",
"assembly": {
"isDefault": true,
"femId": "<string>",
"facilityName": "<string>",
"finalAssemblyRawText": "<string>",
"surveyVersion": "<string>",
"finalAssemblyImpacts": 123,
"printingProductDyeingImpacts": 123,
"totalNormalizedImpacts": 123,
"sipfacilitytype": [
"<string>"
],
"annualProd": "<string>",
"country": "<string>",
"femDescriptor": "<string>",
"year": 123,
"assessmentStatus": "NS"
},
"purchaseOrderId": "<string>",
"purchaseDate": 123,
"impactPerUnit": 123,
"totalImpactPerUnit": 123,
"pmVersion": "<string>",
"msiVersion": "<string>",
"version": "<string>",
"amountPurchase": 123,
"isOutdated": true,
"impactsPerUnitMultiPack": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"totalImpactsMultiPack": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"impactsPerUnit": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"totalImpacts": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
}
}
],
"purchaseOrderImpactsTotal": {
"materialImpact": 123,
"tier1Impact": 123,
"packagingImpact": 123,
"logisticsImpactsUpstreamTD": 123,
"logisticsImpactsDTImpact": 123,
"logisticsImpactsDCImpact": 123,
"logisticsImpactsRetailImpact": 123,
"productCareImpacts": 123,
"endOfUseImpact": 123,
"totalProductImpacts": 123,
"componentImpact": 123
},
"componentImpact": 123,
"upstreamTransportation": 123,
"downstreamTransportationRetail": 123,
"downstreamTransportationConsumer": 123,
"distributionCenterUnOwned": 123,
"retailEnergyUnOwned": 123,
"frenchLabelManufacturingCountry": {
"code": "<string>",
"name": "<string>"
},
"frenchLabelFabricCountry": {
"code": "<string>",
"name": "<string>"
},
"frenchLabelDyeingCountry": {
"code": "<string>",
"name": "<string>"
},
"frenchLabelOptionalFields": {
"countrySpinning": {
"code": "<string>",
"name": "<string>"
},
"upcycled": true,
"price": 123,
"numberOfReferences": 123,
"business": "small-business"
},
"frenchLabelEligibility": {
"eligible": true,
"reasons": [
{
"category": "ProductType",
"message": "<string>"
}
]
},
"frenchLabelEcoScore": {
"score": 123,
"impacts": {
"acd": 123,
"cch": 123,
"etf": 123,
"etfC": 123,
"fru": 123,
"fwe": 123,
"htc": 123,
"htcC": 123,
"htn": 123,
"htnC": 123,
"ior": 123,
"ldu": 123,
"mru": 123,
"ozd": 123,
"pco": 123,
"pma": 123,
"swe": 123,
"tre": 123,
"wtu": 123,
"ecs": 123,
"pef": 123
},
"createdAt": 123,
"updatedAt": 123,
"impactsPercentageContribution": {
"acd": 123,
"cch": 123,
"etf": 123,
"etfC": 123,
"fru": 123,
"fwe": 123,
"htc": 123,
"htcC": 123,
"htn": 123,
"htnC": 123,
"ior": 123,
"ldu": 123,
"mru": 123,
"ozd": 123,
"pco": 123,
"pma": 123,
"swe": 123,
"tre": 123,
"wtu": 123,
"ecs": 123,
"pef": 123
},
"status": "Pending",
"apiVersion": "<string>",
"apiResponseError": "<string>"
}
}
]
}| Field Name | Data Type | Description |
|---|---|---|
id | Array<string> | Filter by specific product IDs. |
name | Array<string> | Filter by product names. |
textSearch | Array<string> | General text search across multiple fields. |
productSize | Array<string> | Filter by product sizes. |
productCategory | Array<string> | Filter by product categories. |
component | Array<string> | Filter by component IDs or names. |
material | Array<string> | Filter by material IDs or names. |
packaging | Array<string> | Filter by packaging IDs or names. |
tag | Array<string> | Filter by tags. |
identifier | Array<string> | Filter by product identifiers (e.g., SKU). |
hasFrenchEcoScore | boolean | Filter products that have a French Eco Score calculated. |
from | number | [DEFAULT: 0] Pagination start index. |
size | number | [DEFAULT: 50] Number of results to return. |
sort | object | Sorting configuration { field: string, order: "asc" | "desc" }. |
from and size.API Search requests
Show child attributes