Skip to main content
POST
/
purchase-orders
/
search
Purchase Orders Search
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/purchase-orders/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,
  "tags": [
    "<string>"
  ],
  "category": [
    "<string>"
  ],
  "productId": [
    "<string>"
  ],
  "purchaseOrderDateAfter": "2023-11-07T05:31:56Z",
  "purchaseOrderDateBefore": "2023-11-07T05:31:56Z",
  "country": [
    "<string>"
  ],
  "supplier": [
    "<string>"
  ]
}
'
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "_id": "<string>",
      "product": {
        "productId": "<string>",
        "name": "<string>",
        "category": "<string>",
        "categoryComplete": "<string>",
        "productCategoryExpansion": {
          "label": "<string>",
          "id": "<string>",
          "picCategory": "<string>",
          "flatFileLabel": "<string>",
          "version": "<string>",
          "receivedOtherId": "<string>"
        },
        "totalImpact": 123,
        "tags": {}
      },
      "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,
        "finishedProductImpacts": 123
      },
      "createdOn": 123,
      "account": {
        "_id": "<string>",
        "name": "<string>",
        "country": "<string>",
        "sacId": 123,
        "oar_id": "<string>",
        "demoaccount": true,
        "socialCreditId": "<string>",
        "taxId": "<string>",
        "bluesignId": "<string>",
        "zdhcId": "<string>",
        "ipeViolation": {
          "totalViolations": 123
        },
        "ffcId": 123
      },
      "user": {
        "_id": "<string>",
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>"
      },
      "purchaseOrderId": "<string>",
      "purchaseDate": "<string>",
      "amountPurchase": 123,
      "pmVersion": "<string>",
      "isOutdated": true,
      "msiVersion": "<string>",
      "version": "<string>",
      "impactPerUnit": 123,
      "totalImpactPerUnit": 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
      },
      "materials": [
        {
          "name": "<string>",
          "netUse": 123,
          "materialId": "<string>",
          "composition": 123,
          "weightInformation": {
            "convertedToKg": 123,
            "weight": 123,
            "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
            }
          }
        }
      ],
      "components": [
        {
          "name": "<string>",
          "componentId": "<string>",
          "unit": 123,
          "weightInformation": {
            "convertedToKg": 123,
            "weight": 123,
            "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,
            "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
            }
          }
        }
      ],
      "weightInformation": {
        "convertedToKg": 123,
        "weight": 123,
        "isPrimaryData": true
      },
      "packagingWeight": {
        "convertedToKg": 123,
        "weight": 123,
        "isPrimaryData": true
      },
      "modifiedBy": {
        "_id": "<string>",
        "email": "<string>",
        "firstname": "<string>",
        "lastname": "<string>"
      },
      "modifiedOn": 123,
      "channelCreate": "<string>",
      "channelUpdate": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.worldly.io/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to search and filter purchase orders across your PIC inventory.

​
Request body params

NameTypeDescription
idArray<string>Filter by specific purchase order IDs.
nameArray<string>Filter by purchase order names.
textSearchArray<string>General text search across multiple fields.
tagsArray<string>Filter by tags.
categoryArray<string>Filter by product category.
productIdArray<string>Filter by associated product IDs.
purchaseOrderDateAfterstring (date-time)Filter purchase orders after this date (e.g., 2025-01-15T00:00:00Z).
purchaseOrderDateBeforestring (date-time)Filter purchase orders before this date (e.g., 2025-12-31T23:59:59Z).
countryArray<string>Filter by country.
supplierArray<string>Filter by supplier.
fromnumber[DEFAULT: 0] Pagination start index.
sizenumber[DEFAULT: 50] Number of results to return (max 50).
sortobjectSorting configuration { field: string, order: "asc" | "desc" }.

​
Implementation Details

  • Pagination: Standard pagination using from and size. Maximum page size is 50.
  • Date formatting: Purchase dates in the response are returned as strings and, when present, typically use the YYYY-MM-DD representation.
  • Filtering: Array fields act as “OR” filters — results match any of the provided values.

Authorizations

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

Body

application/json
​
id
string[] | null
​
name
string[] | null
​
sort
object

API Search requests

​
textSearch
string[] | null
​
from
number<double> | null
​
size
number<double> | null
​
tags
string[] | null
​
category
string[] | null
​
productId
string[] | null
​
purchaseOrderDateAfter
string<date-time> | null
​
purchaseOrderDateBefore
string<date-time> | null
​
country
string[] | null
​
supplier
string[] | null

Response

200 - application/json

Ok

API Search responses

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