Add Packaging

Packaging follows the same pattern as materials — browse the catalog, add it to the screening, then set its details. There are two packaging types: regular packaging and master box.

​

Browse the catalog

Call GET /v1/packagings to fetch available packaging items. Each item has a publicId and an inputs array. The fieldsType on each input determines what to send when adding it:

​

Add the packaging

Call POST /v1/screenings/{screeningId}/packagings using the screening publicId from the screening step. The response includes a screening packaging publicId — save this for the update call.

​

Set packaging details

Call the update endpoint with the screening packaging publicId. Functional unit fields work the same as materials:

• functionalUnitValue — quantity in the chosen unit
• functionalUnitKilogramValue — conversion factor to kg; not needed if the unit is already Kilogram

Packaging-specific fields:

• amount — number of units
• amountType — ProductsPerContainer or PiecesPerProduct
• width, height, depth — dimensions in cm

Per material/process input, set one of:

• locationListItemPublicId — geographical origin (lli_ prefix), from GET /v1/geographical/locations
• transportLocationPublicId — 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.

​

Master box

A master box is a secondary packaging layer used for distribution. It has all the same fields as regular packaging, plus:

• palletPublicId — references a pallet (plt_ prefix); fetch available pallets from GET /v1/packagings/pallets
• amountPerPallet — number of master boxes per pallet; only set if a pallet is selected

​

Next

Retrieve Results →