Products

Product objects from the Pickler DB

· _id string*
Unique identifier for the object.

· createdOn date*
Date and time the object was created.

· updatedOn date*
Date and time the object was updated.

· name string*
Product name.

· status enum ["draft", "verified"]
Product status. Draft by default. Verified is available only for products with 100% completeness.

· image string
URL to product image.

· weightInMg number
Product weight in milligrams (default 1000000)

· salesPrice number
Sales price for this product in cents.

· trueCost number
Sales price and eco-costs added together in cents.

· description string
Description for this product.

· isScenarioProduct boolean
Indicates if the product is inventory (manufactured by the company) or scenario (used for benchmarking only) (default false).

· internal object
Internal object containing additional details about the product.

· internal.productId string
Internal product id.

· internal.category string
Internal category id.

· internal.materials string[]
Internal materials.

· internal.customers object[]
Internal customers.

· internal.customers.name string*
Internal customer name.

· internal.customers.volume number
Internal customer volume. Default value is 0.

· internal.suppliers object[]
Internal suppliers.

· internal.suppliers.name string*
Internal supplier name.

· internal.suppliers.volume number
Internal supplier volume. Default value is 0.

· company object*
Details of the company to which this product belongs.

· company.companyId string*
Unique identifier for the company object.

· company.companyName string*
Company name.

· category object
Description of the category to which the product belongs.

· category.categoryId string*
Unique identifier for the category object from EcoDB.

· category.categoryName string*
Name of category.

· industry array
Description of the industry to which the product belongs.

· industry.industryId string*
Unique identifier for the industry object from EcoDB.

· industry.industryName string*
Name of industry.

· materials array
Materials used in the product.

· components array
Components used in the product.

· components.componentId string*
Unique identifier for the component object from EcoDB.

· components.componentName string*
Component name.

· components.itemId string*
Unique identifier of the element in the array of components.

· components.materials.itemId string*
Unique identifier of the element in the array of materials.

· components.materials.materialId string*
Unique identifier for the material object from EcoDB.

· components.materials.materialName string*
Material name.

· components.materials.share number*
Share of material in product. sum of all shares must be 1.

· components.materials.sourceDisplayName string
Source display name.

· components.materials.sourceLink string
Source link.

· components.materials.tags string[]
Other short names for material name.

· production array
Production methods of product materials. The number of methods depends on the amount of materials in the product.

· production.method.itemId string*
Unique identifier of the element in the array of production methods.

· production.method.methodId string*
Unique identifier for the production method object from EcoDB.

· production.method.componentItemId string*
Unique identifier of the element in the array of components.

· production.method.methodName string*
Production method name.

· production.method.sourceDisplayName string
Source display name.

· production.method.sourceLink string
Source link.

· production.location.locationId string*
Unique identifier for the production location object from EcoDB. Has priority over locationAddress

· production.location.locationAddress string
Human friendly location address that will be mapped to EcoDB location automatically.

· production.location.locationName string*
Location name.

· production.location.sourceDisplayName string
Source display name.

· production.location.sourceLink string
Source link.

· transport object
Product transportation information.

· transport.categories array
Ways of transportation from production to warehouse.

· transport.categories.itemId string*
Unique identifier of the element in the array of transport categories.

· transport.categories.categoryId string*
Unique identifier for the transport category object from EcoDB.

· transport.categories.categoryName string*
Transport method name.

· transport.categories.distance number
Transportation distance in km.

· transport.categories.sourceDisplayName string
Source display name.

· transport.categories.sourceLink string
Source link.

· transport.categories.location object
Origin and destination for transportation step

· transport.categories.location.from.locationId string
Unique identifier for the origin transport location object from EcoDB. Has priority over locationAddress

· transport.categories.location.from.locationAddress string
Human friendly origin location address that will be mapped to EcoDB location automatically

· transport.categories.location.from.locationName string
Location name

· transport.categories.location.from.sourceDisplayName string
Source display name.

· transport.categories.location.from.sourceLink string
Source link.

· transport.categories.location.to.locationId string
Unique identifier for the destination transport location object from EcoDB. Has priority over locationAddress

· transport.categories.location.to.locationAddress string
Human friendly destination location address that will be mapped to EcoDB location automatically

· transport.categories.location.to.locationName string
Location name

· transport.categories.location.to.sourceDisplayName string
Source display name.

· transport.categories.location.to.sourceLink string
Source link.

· transport.pallet object
Transport pallet information.

· transport.pallet.weightInKg number
Weight of a full pallet in kg (default 300).

· transport.pallet.lengthInSm number
Pallet length in sm (default 100).

· transport.pallet.widthInSm number
Pallet width in sm (default 120).

· transport.pallet.heightInSm number
Pallet height in sm (default 180).

· eol array
Product end of life information.

· eol.itemId string*
Unique identifier of the element in the array of eol.

· eol.materialItemId string*
Unique identifier of the element in the array of materials.

· eol.eolTypes object[]*
Product end of life types information.

· eol.eolTypes.eolId string*
Unique identifier for the eol object from EcoDB.

· eol.eolTypes.share number*
Eol type share.

· eol.eolTypes.type enum* ["INCINERATION_EOL", "COMPOSTING_EOL", "RECYCLING_EOL", "LANDFILL_EOL"]
Eol type.

· eol.eolTypes.sourceDisplayName string
Source display name.

· eol.eolTypes.sourceLink string
Source link.

· ecoScore object
Eco-calculation information for each of the product steps.

· ecoScore.ecoCostPerItemTotal number
Eco cost of all stages in euros.

· ecoScore.ecoCostPerKgTotal number
Eco cost per KG of all stages in euros.

· ecoScore.carbonFootprintPerItemTotal number
Carbon footprint of all stages.

· ecoScore.carbonFootprintPerKgTotal number
Carbon footprint per FG of all stages.

· ecoScore.ecoScorePerKg enum ["A", "B", "C", "D", "E", "F", "G"]
Product eco score.

· ecoScore.components object
Eco-calculation information for materials.

· ecoScore.components.items array*
Eco-calculation information for each material.

· ecoScore.components.items.componentItemId string*
Unique identifier of the element in the array of components.

· ecoScore.components.items.ecoCostPerKg number*
Eco cost of the element per kg in euros.

· ecoScore.components.items.carbonFootprintPerKg number*
Carbon footprint of the element per kg.

· ecoScore.components.items.ecoCostPerItem number*
Eco cost of the element in euros.

· ecoScore.components.items.carbonFootprintPerItem number*
Carbon footprint of the element.

· ecoScore.components.ecoCostPerKg number*
Eco cost of all stage elements per kg in euros.

· ecoScore.components.carbonFootprintPerKg number*
Carbon footprint of all stage elements per kg.

· ecoScore.components.ecoCostPerItem number*
Eco cost of all stage elements in euros.

· ecoScore.components.carbonFootprintPerItem number*
Carbon footprint of all stage elements.

· ecoScore.components.share number
Share of material stage.

· ecoScore.components.items.materials array*
Eco-calculation information for each material.

· ecoScore.components.items.materials.materialItemId string*
Unique identifier of the element in the array of materials.

· ecoScore.components.items.materials.ecoCostPerKg number*
Eco cost of the element per kg in euros.

· ecoScore.components.items.materials.carbonFootprintPerKg number*
Carbon footprint of the element per kg.

· ecoScore.components.items.materials.ecoCostPerItem number*
Eco cost of the element in euros.

· ecoScore.components.items.materials.carbonFootprintPerItem number*
Carbon footprint of the element.

· ecoScore.production object
Eco-calculation information for production.

· ecoScore.production.items array*
Eco-calculation information for each production method.

· ecoScore.production.items.methodItemId string*
Unique identifier of the element in the array of production methods.

· ecoScore.production.items.ecoCostPerKg number*
Eco cost of the element per kg in euros.

· ecoScore.production.items.carbonFootprintPerKg number*
Carbon footprint of the element per kg.

· ecoScore.production.items.ecoCostPerItem number*
Eco cost of the element in euros.

· ecoScore.production.items.carbonFootprintPerItem number*
Carbon footprint of the element.

· ecoScore.production.ecoCostPerKg number
Eco cost of all stage elements per kg in euros.

· ecoScore.production.carbonFootprintPerKg number
Carbon footprint of all stage elements per kg.

· ecoScore.production.ecoCostPerItem number
Eco cost of all stage elements in euros.

· ecoScore.production.carbonFootprintPerItem number
Carbon footprint of all stage elements.

· ecoScore.production.share number
Share of production stage.

· ecoScore.transport object
Eco-calculation information for transport.

· ecoScore.transport.categories array*
Eco-calculation information for each transport category.

· ecoScore.transport.categories.categoryItemId string*
Unique identifier of the element in the array of transport category.

· ecoScore.transport.categories.ecoCostPerKg number*
Eco cost of the element per kg in euros.

· ecoScore.transport.categories.carbonFootprintPerKg number*
Carbon footprint of the element per kg.

· ecoScore.transport.categories.ecoCostPerItem number*
Eco cost of the element in euros.

· ecoScore.transport.categories.carbonFootprintPerItem number*
Carbon footprint of the element.

· ecoScore.transport.ecoCostPerKg number
Eco cost of all stage elements per kg in euros.

· ecoScore.transport.carbonFootprintPerKg number
Carbon footprint of all stage elements per kg.

· ecoScore.transport.ecoCostPerItem number
Eco cost of all stage elements in euros.

· ecoScore.transport.carbonFootprintPerItem number
Carbon footprint of all stage elements.

· ecoScore.transport.share number
Share of transport stage.

· ecoScore.eol object
Eco-calculation information for eol.

· ecoScore.eol.items array*
Eco-calculation information for each eol.

· ecoScore.eol.items.eolItemId string*
Unique identifier of the element in the array of eols.

· ecoScore.eol.items.ecoCostPerKg number*
Eco cost of the element per kg in euros.

· ecoScore.eol.items.carbonFootprintPerKg number*
Carbon footprint of the element per kg.

· ecoScore.eol.items.ecoCostPerItem number*
Eco cost of the element in euros.

· ecoScore.eol.items.carbonFootprintPerItem number*
Carbon footprint of the element.

· ecoScore.eol.ecoCostPerKg number
Eco cost of all stage elements per kg in euros.

· ecoScore.eol.carbonFootprintPerKg number
Carbon footprint of all stage elements per kg.

· ecoScore.eol.ecoCostPerItem number
Eco cost of all stage elements in euros.

· ecoScore.eol.carbonFootprintPerItem number
Carbon footprint of all stage elements.

· ecoScore.eol.share number
Share of eol stage.

Adds new product to products portfolio with the values of the parameters passed.
This request body is multipart/form-data encoded.
There are 2 fields:
​json : that is products representation as stringified json value. Body example below.

images : that is array of product images

· products array*
Array of options for products.

· products.name string*
Product name. Max 50.

· products.status enum ["draft", "verified"]
Product status. Draft by default. Verified is available only for products with 100% completeness.

· products.image string | number | null
URL to product image (max length 2048) or index of product image from images array.

· products.weightInMg number
Product weight in milligrams (default 1000000). Greater than 0 and maximum 1000 000 000.

· products.measureUnit enum ["Share", "mU", "Gram", "Gsm"] Measure unit of materials share, according to product weight. Share by default.

· products.salesPrice number
Sales price for this product in euro. Minimum 0.01 and maximum 1000 000.

· products.description string
Description for this product. Maximum 500.

· products.inventoryNumber string
Product inventory number. Maximum 50.

· products.isScenarioProduct boolean
Indicates if the product is inventory (manufactured by the company) or scenario (used for benchmarking only) (default false).

· products.category object
Description of the category to which the product belongs.

· products.category.categoryId string*
Unique identifier for the category object from EcoDB.

· products.industry array
Description of the industries to which the product belongs.

· products.industry.industryId string*
Unique identifier for the industry object from EcoDB.

· products.internal object
Internal object containing additional details about the product.

· products.internal.productId string
Internal product id.

· products.internal.category string
Internal category id.

· products.internal.materials string[]
Internal materials.

· products.internal.customers object[]
Internal customers.

· products.internal.customers.name string*
Internal customer name.

· products.internal.customers.volume number
Internal customer volume. Default value is 0.

· products.internal.suppliers object[]
Internal suppliers.

· products.internal.suppliers.name string*
Internal supplier name.

· products.internal.suppliers.volume number
Internal supplier volume. Default value is 0.

· products.components array
Components used in the product.

· products.components.componentId string*
Unique identifier for the component object from EcoDB.

· products.components.itemId string*
Unique identifier of the element in the array of components.

· products.components.materials array
Materials used in the component.

· products.components.materials.itemId string*
Unique identifier of the element in the array of materials.

· products.components.materials.materialId string*
Unique identifier for the material object from EcoDB.

· products.components.materials.share number*
Share of material in product. If measureUnit=”Share”, the sum of all shares must be 1. If another measure unit is selected, the sum of all shares must equal the package weight. Min 0.001.

· products.production array
Production methods of product materials. The number of methods depends on the amount of materials in the product.

· products.production.method object
Production item method

· products.production.method.itemId string*
Unique identifier of the element in the array of production methods.

· products.production.method.methodId string*
Unique identifier for the production method object from EcoDB.

· products.production.method.materialItemId string*
Unique identifier of the element in the array of materials.

· products.production.location object
Production item location.

· products.production.location.locationId string
Unique identifier for the production location object from EcoDB. Has priority over locationAddress

· products.production.location.locationAddress string
Human friendly location address that will be mapped to EcoDB location automatically.

· products.transport object
Product transportation information.

· products.transport.categories array
Ways of transportation from production to warehouse.

· products.transport.categories.itemId string*
Unique identifier of the element in the array of transport categories.

· products.transport.categories.categoryId string*
Unique identifier for the transport category object from EcoDB.

· products.transport.categories.distance number
Transportation distance in km. Greater than 0 and maximum 1000 000.

· products.transport.categories.location object
Transport category item location.

· products.transport.categories.location.from.locationId string
Unique identifier for the transport origin location object from EcoDB. Has priority over locationAddress

· products.transport.categories.location.from.locationAddress string
Human friendly origin location address that will be mapped to EcoDB location automatically.

· products.transport.categories.location.to.locationId string
Unique identifier for the transport destination location object from EcoDB. Has priority over locationAddress

· products.transport.categories.location.to.locationAddress string
Human friendly origin location address that will be mapped to EcoDB location automatically.

· products.transport.pallet object
Transport pallet information.

· products.transport.pallet.weightInKg number
Weight of a full pallet in kg (default 300). Greater than 0 and maximum 1000 000.

· products.transport.pallet.lengthInSm number
Pallet length in sm (default 100). Greater than 0 and maximum 1000 000.

· products.transport.pallet.widthInSm number
Pallet width in sm (default 120). Greater than 0 and maximum 1000 000.

· products.transport.pallet.heightInSm number
Pallet height in sm (default 180). Greater than 0 and maximum 1000 000.

Only used when the isScenarioProduct field is true

· products.eol object[]
Product eol information.

· products.eol.itemId string*
Unique identifier of the element in the array of eol.

· products.eol.materialItemId string*
Unique identifier of the element in the array of materials.

· products.eol.eolTypes object[]*
Product end of life types information.

· products.eol.eolTypes.share number*
Eol type share.

· products.eol.eolTypes.type enum* ["INCINERATION_EOL", "COMPOSTING_EOL", "RECYCLING_EOL", "LANDFILL_EOL"]
Eol type.

Returns an array of created products.

Returns a list of your company products with the given IDs.

· ids array*
List of product IDs.

Returns full data about the products, including all submitted fields, automatically assigned fields and calculated eco-data.

eol is assigned automatically, if ID’s of materials where SEND to the system.

ecoCost and carbonFootprint are returned for each stage and total for the product.

Returns a list of your company products.

· page number
Page number (default 1).

· perPage number
Number of products per page (default 25).

· searchValue string
Search by product text fields (name, inventoryNumber, description, categoryIndustry, categoryName, materialName, methodName, locationName, categoryName, eolName).

· isScenarioProduct boolean
Indicates if the product is inventory (manufactured by the company) or scenario (used for benchmarking only) (default false).

· ecoScores enum[] ["A", "B", "C", "D", "E", "F", "G"]
Filter products by eco score.

· ecoCostPerItemTotal object
Filter products by eco cost.

· ecoCostPerItemTotal.from number
Minimum value to filter by eco cost.

· ecoCostPerItemTotal.to number
Maximum value to filter by eco cost.

· carbonFootprintPerItemTotal object
Filter products by carbon footprint

· carbonFootprintPerItemTotal.from number
Minimum value to filter by carbon footprint.

· carbonFootprintPerItemTotal.from number
Minimum value to filter by carbon footprint.

· industries string[]
Filtering products by unique industry identifiers.

· productCategories string[]
Filtering products by unique product category identifiers.

· materials string[]
Filtering products by unique material identifiers.

· productionMethods string[]
Filtering products by unique production method identifiers.

· productionLocations string[]
Filtering products by unique production location identifiers.

· transportMethods string[]
Filtering products by unique transport method identifiers.

· eolTypes enum[] ["INCINERATION_EOL", "COMPOSTING_EOL", "RECYCLING_EOL", "LANDFILL_EOL"]
Filtering products by unique EOL type.

Returns full data about the products with pagination, including all submitted fields, automatically assigned fields and calculated eco-data.

eol is assigned automatically, if ID’s of materials where SEND to the system.

ecoCost and carbonFootprint are returned for each stage and total for the product.

Re-writes selected products in the Pickler DB. Only those fields that need to be changed must be filled in.

This request body is multipart/form-data encoded.
There are 2 fields:
​json : that is products representation as stringified json value. Body example below.

images : that is array of product images

Same as for Create products

Returns an array of updated products.

Removes selected products from the Pickler DB

· ids array*
List of product IDs.

Returns list of deleted product IDs.

Creating a urls to get public access to the eco forecast page.

· ids array*
List of product IDs.

Returns urls to eco forecast page and iframe.