Search Tier 1 facilities - Worldly Developer Docs

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>"
  ]
}
'

{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "verificationPosted": true,
      "tags": [
        "<string>"
      ],
      "annualProdVolUnits": "<string>",
      "year": 123,
      "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>"
      ],
      "finishedProductImpacts": 123
    }
  ]
}

POST

supplier

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>"
  ]
}
'

{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "verificationPosted": true,
      "tags": [
        "<string>"
      ],
      "annualProdVolUnits": "<string>",
      "year": 123,
      "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>"
      ],
      "finishedProductImpacts": 123
    }
  ]
}

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.

Filter results by assessment module type. See the AssessmentRfiPid enum in the API playground for the full list of supported values.

Filter results by assessment status. See the AssessmentStatus enum in the API playground for the full list of supported values.

Request body properties

Name	Type	Description
`femIds`	`Array<string>`	Filter by specific FEM assessment IDs.
`moduleType`	`string`	Assessment module type (e.g. `fem2025`).
`status`	`string`	Assessment status (e.g. `ASC` for completed).

Response body properties

Name	Type	Description
`from`	`number`	[REQUIRED] Starting index of the results.
`size`	`number`	[REQUIRED] Number of results returned per page.
`total`	`number`	[REQUIRED] Total number of facilities matching the search criteria.
`results`	`Array<AssemblyLibrary>`	[REQUIRED] List of facilities and their assessment data.

Result item properties

Each entry in results is an AssemblyLibrary object. The fields below are the common subset most callers consume; refer to the API playground for the complete schema (additional fields include accountId, accountCountry, tags, customIds, verificationPosted, and impact metric blocks).

Name	Type	Description
`femId`	`string`	[REQUIRED] Unique ID of the FEM assessment.
`accountName`	`string`	[REQUIRED] Name of the facility’s account.
`country`	`string`	[REQUIRED] Country where the facility is located.
`year`	`number`	[REQUIRED] Assessment year.
`status`	`string`	[REQUIRED] Assessment status code.
`moduleType`	`string`	[REQUIRED] The type of assessment module.
`sacId`	`number`	[REQUIRED] The Sustainable Apparel Coalition ID for the facility.
`oarId`	`string`	The Open Apparel Registry ID for the facility.

Implementation details

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

Refer to the PIC Data Dictionary for more information on PIC fields.

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

API Search responses

from

number<double>

required

size

number<double>

required

total

number<double>

required

results

object[]

required

Show child attributes

FEM Linking Impact Reports

Documentation Index

​Request body properties

​Response body properties

​Result item properties

​Implementation details

Authorizations

Body

Response

Request body properties

Response body properties

Result item properties

Implementation details