Browse the catalog
Call GET /v1/materials to fetch available materials. Each item has aninputs array. Save the itemPublicId and note the fieldsType for each input — this determines what you send in the next step.
fieldsType | What to send |
|---|---|
Default | itemPublicId only |
Single | itemPublicId + one data.publicId from fields as itemSelectableMaterialPublicId |
Multiple | itemPublicId + one or more data.publicId from fields as itemSelectableMaterialPublicId |
Add the material
Call POST /v1/screenings/{screeningId}/materials using the screeningpublicId from the screening step.
The response includes a screening material publicId — save this for the update call.
Set material details
Call the update endpoint with the screening materialpublicId to fill in the remaining details.
Functional unit fields:
functionalUnitValue— quantity in the chosen unitfunctionalUnitKilogramValue— conversion factor to kg; not needed if the unit is alreadyKilogram
locationListItemPublicId— geographical origin (lli_prefix), from GET /v1/geographical/locationstransportLocationPublicId— supplier location (trl_prefix), from your created locations
recycleShare — recycle percentage, only available if the item supports it.
For Multiple type inputs, also set proportion on each entry — values must sum to 1.0.