Get a product by its id
GET/partner/v1.0/organizations/:organizationId/products/:id
Get a product by its id
Request
Path Parameters
The ID of the organization in the Carbon Trail platform
The ID of the product
Responses
- 200
OK
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- ComponentProduct
- FabricComponentProduct
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
The unique identifier of the product.
The timestamp when the product was produced.
Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment]
The category of the product.
The type of the product.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
components
object[]
nullable
The list of components that make up the product.
The unique identifier of the component.
The type of the component. Could be 'Fabric', 'Component' etc.
The unique identifier of the component For fabrics, this is the fabric ID.
The quantity or amount of the component used.
The unit of measurement for the component amount.
componentProduct
object
nullable
The detailed component product information for this component.
oneOf
Acts as a base for all component products.
Generic components use this directly
category
string
required
Possible values: [Fabric]
The category of the product.
The type of the fabric component product. Equal to 'Fabric'.
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
yarnSizeValue
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
The GSM of the fabric
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
Represents a fabric product entity, which is a specific type of component product.
category
string
required
Possible values: [Fabric]
The category of the product.
circular(FabricComponentProduct)
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
yarnSizeValue
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
The GSM of the fabric
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
{
"id": "string",
"productionTimestamp": "2024-07-29T15:51:28.071Z",
"category": "Apparel",
"type": "string",
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"name": "string",
"articleNumber": "string",
"sku": "string",
"materials": [
{
"name": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"materialPercentageInComponent": 0,
"recyclingInformation": {
"recyclingPercentage": 0,
"recyclingSource": "string",
"recyclingCollection": "Pre-Consumer",
"recyclingProcess": "Mechanical"
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"utilizationRatio": 0,
"distanceInKms": 0,
"mode": "Truck"
}
]
}
],
"certifications": [
"string"
]
}
],
"accessories": [
{
"type": "string",
"amount": 0,
"unit": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
}
}
],
"packaging": {
"materials": [
{
"material": "string",
"type": "Primary",
"weightInGms": 0,
"supplierId": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"recyclingInformation": {
"recyclingPercentage": 0,
"recyclingSource": "string",
"recyclingCollection": "Pre-Consumer",
"recyclingProcess": "Mechanical"
}
}
]
},
"weightInGms": 0,
"intrinsicValue": 0,
"organizationId": "string",
"subsidiaryId": "string",
"certifications": [
"string"
],
"passportEnabled": true,
"status": "Active",
"components": [
{
"id": "string",
"type": "string",
"sku": "string",
"amount": 0,
"unit": "string",
"componentProduct": {}
}
],
"hazardousSubstances": [
"string"
],
"cutOffDate": "2024-07-29T15:51:28.071Z",
"submitterUserEmail": "string",
"customFieldValues": [
{},
null,
null,
null
],
"manufacturingDetails": {
"processes": [
{
"name": "string",
"performed": true,
"technology": "string",
"supplierId": "string",
"facilityId": "string",
"location": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"lossPercentage": 0,
"flowSequenceNumber": 0,
"applicableSurfaceArea": {
"value": 0,
"unit": "string"
},
"percentageShare": 0
}
],
"lossPercentage": 0,
"manufacturingLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"supplierId": "string",
"facilityId": "string",
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"utilizationRatio": 0,
"distanceInKms": 0,
"mode": "Truck"
}
]
}
]
}
}
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- ComponentProduct
- FabricComponentProduct
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
The unique identifier of the product.
The timestamp when the product was produced.
Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment]
The category of the product.
The type of the product.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
components
object[]
nullable
The list of components that make up the product.
The unique identifier of the component.
The type of the component. Could be 'Fabric', 'Component' etc.
The unique identifier of the component For fabrics, this is the fabric ID.
The quantity or amount of the component used.
The unit of measurement for the component amount.
componentProduct
object
nullable
The detailed component product information for this component.
oneOf
Acts as a base for all component products.
Generic components use this directly
category
string
required
Possible values: [Fabric]
The category of the product.
The type of the fabric component product. Equal to 'Fabric'.
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
yarnSizeValue
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
The GSM of the fabric
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
Represents a fabric product entity, which is a specific type of component product.
category
string
required
Possible values: [Fabric]
The category of the product.
circular(FabricComponentProduct)
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
yarnSizeValue
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
The GSM of the fabric
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
{
"id": "string",
"productionTimestamp": "2024-07-29T15:51:28.071Z",
"category": "Apparel",
"type": "string",
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"name": "string",
"articleNumber": "string",
"sku": "string",
"materials": [
{
"name": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"materialPercentageInComponent": 0,
"recyclingInformation": {
"recyclingPercentage": 0,
"recyclingSource": "string",
"recyclingCollection": "Pre-Consumer",
"recyclingProcess": "Mechanical"
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"utilizationRatio": 0,
"distanceInKms": 0,
"mode": "Truck"
}
]
}
],
"certifications": [
"string"
]
}
],
"accessories": [
{
"type": "string",
"amount": 0,
"unit": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
}
}
],
"packaging": {
"materials": [
{
"material": "string",
"type": "Primary",
"weightInGms": 0,
"supplierId": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"recyclingInformation": {
"recyclingPercentage": 0,
"recyclingSource": "string",
"recyclingCollection": "Pre-Consumer",
"recyclingProcess": "Mechanical"
}
}
]
},
"weightInGms": 0,
"intrinsicValue": 0,
"organizationId": "string",
"subsidiaryId": "string",
"certifications": [
"string"
],
"passportEnabled": true,
"status": "Active",
"components": [
{
"id": "string",
"type": "string",
"sku": "string",
"amount": 0,
"unit": "string",
"componentProduct": {}
}
],
"hazardousSubstances": [
"string"
],
"cutOffDate": "2024-07-29T15:51:28.071Z",
"submitterUserEmail": "string",
"customFieldValues": [
{},
null,
null,
null
],
"manufacturingDetails": {
"processes": [
{
"name": "string",
"performed": true,
"technology": "string",
"supplierId": "string",
"facilityId": "string",
"location": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"lossPercentage": 0,
"flowSequenceNumber": 0,
"applicableSurfaceArea": {
"value": 0,
"unit": "string"
},
"percentageShare": 0
}
],
"lossPercentage": 0,
"manufacturingLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"supplierId": "string",
"facilityId": "string",
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"utilizationRatio": 0,
"distanceInKms": 0,
"mode": "Truck"
}
]
}
]
}
}
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- ComponentProduct
- FabricComponentProduct
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
The unique identifier of the product.
The timestamp when the product was produced.
Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment]
The category of the product.
The type of the product.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
components
object[]
nullable
The list of components that make up the product.
The unique identifier of the component.
The type of the component. Could be 'Fabric', 'Component' etc.
The unique identifier of the component For fabrics, this is the fabric ID.
The quantity or amount of the component used.
The unit of measurement for the component amount.
componentProduct
object
nullable
The detailed component product information for this component.
oneOf
Acts as a base for all component products.
Generic components use this directly
category
string
required
Possible values: [Fabric]
The category of the product.
The type of the fabric component product. Equal to 'Fabric'.
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
yarnSizeValue
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
The GSM of the fabric
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
Represents a fabric product entity, which is a specific type of component product.
category
string
required
Possible values: [Fabric]
The category of the product.
circular(FabricComponentProduct)
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
The name of the raw material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The list of certifications associated with this raw material.
accessories
object[]
nullable
The list of accessories associated with the product.
The type of the accessory.
The quantity or amount of the accessory.
The unit of measurement for the accessory amount.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
The weight of the packaging material in grams.
The unique identifier of the supplier for this packaging material.
supplierLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
recyclingInformation
object
Represents recycling information for a material.
The percentage of the material that is recycled.
The source of the recycled material.
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
The weight of the product in grams.
The intrinsic value of the product.
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
yarnSizeValue
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
The GSM of the fabric
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
The name of the manufacturing process.
Indicates whether the process has been performed.
The technology used in the manufacturing process.
The unique identifier of the supplier.
The unique identifier of the facility where the process takes place.
location
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The loss percentage of this process.
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
The overall loss percentage across the entire manufacturing. Don't use this if you are specifying loss % at a process-level.
manufacturingLocation
object
Represents a geographical location.
The unique identifier of the location.
The name of the city.
The country code.
The full name of the country.
The name of the continent.
The unique identifier of the supplier.
The unique identifier of the manufacturing facility.
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
The utilization ratio which represents the % of the transport mode that is utilized for moving the item.
The distance covered as part of this leg.
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
{
"id": "string",
"productionTimestamp": "2024-07-29T15:51:28.071Z",
"category": "Apparel",
"type": "string",
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"name": "string",
"articleNumber": "string",
"sku": "string",
"materials": [
{
"name": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"materialPercentageInComponent": 0,
"recyclingInformation": {
"recyclingPercentage": 0,
"recyclingSource": "string",
"recyclingCollection": "Pre-Consumer",
"recyclingProcess": "Mechanical"
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"utilizationRatio": 0,
"distanceInKms": 0,
"mode": "Truck"
}
]
}
],
"certifications": [
"string"
]
}
],
"accessories": [
{
"type": "string",
"amount": 0,
"unit": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
}
}
],
"packaging": {
"materials": [
{
"material": "string",
"type": "Primary",
"weightInGms": 0,
"supplierId": "string",
"supplierLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"recyclingInformation": {
"recyclingPercentage": 0,
"recyclingSource": "string",
"recyclingCollection": "Pre-Consumer",
"recyclingProcess": "Mechanical"
}
}
]
},
"weightInGms": 0,
"intrinsicValue": 0,
"organizationId": "string",
"subsidiaryId": "string",
"certifications": [
"string"
],
"passportEnabled": true,
"status": "Active",
"components": [
{
"id": "string",
"type": "string",
"sku": "string",
"amount": 0,
"unit": "string",
"componentProduct": {}
}
],
"hazardousSubstances": [
"string"
],
"cutOffDate": "2024-07-29T15:51:28.071Z",
"submitterUserEmail": "string",
"customFieldValues": [
{},
null,
null,
null
],
"manufacturingDetails": {
"processes": [
{
"name": "string",
"performed": true,
"technology": "string",
"supplierId": "string",
"facilityId": "string",
"location": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"lossPercentage": 0,
"flowSequenceNumber": 0,
"applicableSurfaceArea": {
"value": 0,
"unit": "string"
},
"percentageShare": 0
}
],
"lossPercentage": 0,
"manufacturingLocation": {
"id": "string",
"city": "string",
"country": "string",
"countryName": "string",
"continent": "string"
},
"supplierId": "string",
"facilityId": "string",
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"utilizationRatio": 0,
"distanceInKms": 0,
"mode": "Truck"
}
]
}
]
}
}