Skip to main content
POST
/
supplier
/
search
Facility Search
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/supplier/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "femIds": [
    "<string>"
  ],
  "moduleType": "fem2017",
  "status": "NS"
}
'
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "verificationPosted": true,
      "tags": [
        "<string>"
      ],
      "annualProdVolUnits": "<string>",
      "status": "NS",
      "year": 123,
      "rfi_pid": "fem2017",
      "femId": "<string>",
      "accountName": "<string>",
      "accountId": "<string>",
      "accountCountry": "<string>",
      "customIds": [
        "<string>"
      ],
      "sipfacilitytype": [
        "<string>"
      ],
      "moduleType": "<string>",
      "sacId": 123,
      "country": "<string>",
      "surveyVersion": "<string>",
      "facilityPosted": true,
      "finalAssemblyImpacts": 123,
      "printingProductDyeingImpacts": 123,
      "totalNormalizedImpacts": 123,
      "oarId": "<string>",
      "materialProductionNormalized": 123,
      "rawMaterialProcessingNormalized": 123,
      "sipFacilityMaterialProcessTextiles": [
        "<string>"
      ]
    }
  ]
}
Use this endpoint to search for Tier 1 Final Assembly facilities whose FEM assessments have been shared with your Worldly account. The returned FEM assessment IDs can be linked to purchase orders for more accurate Scope 3 impact calculations.

​
Request body params

Field NameData TypeDescription
femIdsArray<string>Filter by specific FEM assessment IDs.
moduleTypestringAssessment module type (e.g., fem2025). See the AssessmentRfiPid enum in the API playground for all values.
statusstringAssessment status (e.g., ASC for completed). See the AssessmentStatus enum in the API playground for all values.

​
Implementation Details

  • Shared assessments only: Only FEM assessments that suppliers have shared with your account are returned.
  • Usage: Use the returned FEM assessment IDs in the purchaseOrder.assembly.femId field when creating or updating purchase orders.

Authorizations

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

Body

application/json
​
femIds
string[] | null
​
moduleType
enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:
fem2017,
fem2018,
fem2019,
fem2020,
fem2021,
fem2022,
fem2023,
fem2024,
fem2025,
fslm,
brm2019,
brm2020,
brm2021,
brm2022,
brm2023,
brm2024,
brm2025,
dct,
one2022,
ffc
​
status
enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentStatus".

Available options:
NS,
ASI,
ASC,
VRP,
VRQ,
VRE,
VRC,
VRD,
VRF,
VRI,
ASD

Response

200 - application/json

Ok

API Search responses

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