Skip to main content
POST
/
packaging
/
search
Packaging List
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/packaging/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "ids": [
    "<string>"
  ],
  "textSearch": "<string>"
}
'
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "_id": "<string>",
      "type": "<string>",
      "impacts": {
        "tier4Impact": 123,
        "tier2and3Impact": 123,
        "totalMaterialLibrary": 123,
        "totalTierImpact": 123,
        "uncertainty": {
          "lower": 123,
          "upper": 123
        }
      },
      "name": "<string>",
      "createdOn": 123,
      "weightInformation": {
        "convertedToKg": 123,
        "weight": 123,
        "unit": "kilograms",
        "isPrimaryData": true
      },
      "_rev": "<string>",
      "packagingMsiId": "<string>",
      "code": "<string>",
      "vendor": "<string>",
      "modifiedOn": 123,
      "deleted": true,
      "dataSource": "<string>",
      "description": "<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"
      },
      "productNumber": "<string>",
      "packagingType": "<string>",
      "version": "<string>",
      "visibleForAccounts": [
        "<string>"
      ],
      "defectRate": 123
    }
  ]
}
Use this endpoint to search the packaging catalog. Packaging items represent the materials used to package a product (e.g., polybags, cardboard boxes) and contribute to the product’s environmental impact calculation.

Request body params

Field NameData TypeDescription
textSearchstringSearch packaging by name.
idsArray<string>Filter by specific packaging IDs.
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: Maximum page size is capped at 50 results.
  • Usage: Each packaging item in the response includes an _id field. Use this _id value as the packagingId in the packaging array when creating or updating products.

Authorizations

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

Body

application/json
from
number<double> | null
size
number<double> | null
ids
string[] | null
sort
object

API Search requests

textSearch
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