The number of items to return.
FairlyMade API (2.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/
Sandbox Server
https://sandbox.api.fairlymade.com/
Production Server
https://api.fairlymade.com/
- Accounts : user account
- Collections : user collection (e.g : SpringSummer22) which gathers products
- Components: component of the products
- Links: links that lead to a showcase
- Products : products of the user
- Suppliers : suppliers the user works with for its products and components
With the "get all" routes you can get the id and/or ref (that you provided) for each items.
You can use both in "get by id" routes.
You have to create the supplier before the product because it refers to the supplier.
If you know the supplier of the component, please create it aswell, otherwise this information is no required for component creation.
Once it is created you can reuse the unique supplierRef you mentioned for product and/or component creation.
You have to create the product before the component because it refers to the product. Once it is created you can reuse the unique productRef you mentioned for component creation.
You can see that there is a colorCode field in the product request body, please note that, if the product has different color codes, you have to create this product once per color code. It allows Fairly Made to make a study by color for the product in question.
If the collection to which the product belongs does not already exists in your collections (you can check that by using the "get all" route on brand-collections) it will be created at the same time as the product thanks to the collectionRef field.
You can create a component and link it to the appropriate product thanks to the productRef. Please fill the collection and the product color code to link the component to the right study.
Note that if you have a component which is used in several products of the same collection, you have to create this component once per concerned product. To do so, you can change the productRef and/or the colorCode fields depending on the products concerned.
Regarding collectionRef, supplierRef, productRef and componentRef, we encourage to use URL-friendly strings. But if those informations are formatted differently in your system you can fill it in the same way. Please note that you will need URL encoding to use your refs on "get by id" routes. Otherwise you also have the possibility to use our ids which are returned in "get all" routes.
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/packaging
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/packaging
- Production Server
https://api.fairlymade.com/v2/packaging
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/packaging?limit=20&offset=0&sortBy=string&sortDesc=true&search=string'Response
application/json
{ "offset": 0, "limit": 20, "total": 0, "data": [ { … } ] }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/packaging/{id}
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/packaging/{id}
- Production Server
https://api.fairlymade.com/v2/packaging/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/packaging/{id}'Response
application/json
{ "id": "string", "packagingRef": "string", "type": "string" }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/products
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/products
- Production Server
https://api.fairlymade.com/v2/products
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/products?limit=20&offset=0&sortBy=string&sortDesc=true&search=string' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Response
application/json
{ "offset": 0, "limit": 20, "total": 0, "data": [ { … } ] }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/products/{id}
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/products/{id}
- Production Server
https://api.fairlymade.com/v2/products/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/products/{id}' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Response
application/json
{ "id": "string", "ref": [ "string" ], "name": "string", "category": "string", "studies": [ { … } ] }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/studies
- Production Server
https://api.fairlymade.com/v2/studies
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies?lang=fr&collectionRef=string&productRef=string&colorCode=string' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Bodyapplication/json
Last known state of study's progress
Enum"PLANNED""REVIEWED""ARCHIVED""PUBLISHED""COMPLETED""IN_PROGRESS""CANCELLED"
List of certifications tied to this product
A list of components linked to this study
General composition of the component separated by semi-colons
A list of material used to make the component
Percentage of this material the parent component is made of
components[].composition[].traceability_stepsArray of objects(TraceabilityStepFormatShowcase)required
A list of traceability steps making a full branch from this material to the upmost parent (should be product)
Unique identifier of this traceability step
Three sets of numbers going from 001 to 999, giving the absolute position of the traceability step in the tree
Icon attached to the traceability step
components[].composition[].traceability_steps[].transportsArray of objects(TraceabilityStepTransportDto)required
List of all means of transportation travelling from this traceability step
Default transportation type assigned
City of this supplier
Country of this supplier
Region of this supplier
components[].composition[].traceability_steps[].supplier.socialCertificationsArray of objects(CertificationFormatShowcase)required
List of social certifications this supplier has
components[].composition[].traceability_steps[].supplier.environmentalCertificationsArray of objects(CertificationFormatShowcase)required
List of environmental certifications this supplier has
Indicates if the supplier is known by the system
Example: {"en":"Paddings","fr":"Rembourrage","es":"Acolchado"}
EF impact category that addresses the use of non-renewable abiotic natural resources (minerals and metals) (in kg Sb eq)
EF impact category that addresses the use of non-renewable fossil natural resources (e.g. natural gas, coal, oil) (in MJ)
Impacts due to acidifying substances in the environment. The protons contribute to the acidification of soils and water when they are released in areas where the buffering capacity is low, resulting in forest decline and lake acidification (in mol H+ eq)
EF impact category that accounts for adverse health effects on human beings caused by the intake of toxic substances through inhalation of air, food/water ingestion, penetration through the skin insofar as they are related to cancer (in CTUh)
EF impact category that accounts for the adverse health effects on human beings caused by the intake of toxic substances through inhalation of air, food/water ingestion, penetration through the skin insofar as they are related to non-cancer effects (in CTUh)
Nutrients from sewage outfalls and fertilised farmland accelerate the growth of algae and other vegetation in water. The degradation of organic material consumes oxygen resulting in oxygen deficiency and, in some cases, fish death (in kg P eq)
Nutrients from sewage outfalls and fertilised farmland accelerate the growth of algae and other vegetation in water. The degradation of organic material consumes oxygen resulting in oxygen deficiency and, in some cases, fish death (in kg N eq)
Nutrients from sewage outfalls and fertilised farmland accelerate the growth of algae and other vegetation in water. The degradation of organic material consumes oxygen resulting in oxygen deficiency and, in some cases, fish death (in mol N eq)
All inputs or outputs that result in greenhouse gas emissions. The consequences include increased average global temperatures and sudden regional climatic changes. Climate change is an impact affecting the environment on a global scale (in kg CO2 eq)
EF impact category that accounts for the adverse health effects on human health caused by radioactive releases (in kBq U235 eq)
Use (occupation) and conversion (transformation) of land area by activities such as agriculture, forestry, roads, housing, mining, etc. (in points)
Degradation of stratospheric ozone due to emissions of ozone-depleting substances, for example long-lived chlorine and bromine containing gases (e.g. CFCs, HCFCs, Halons) (in kg CFC^-11 eq)
EF impact category that accounts for the adverse health effects on human health caused by emissions of Particulate Matter (PM) and its precursors (NOx, SOx, NH3) (Diseace Incidence)
Formation of ozone at the ground level of the troposphere caused by photochemical oxidation of volatile organic compounds (VOCs). High concentrations of ground-level tropospheric ozone damage vegetation, human respiratory tracts and manmade materials through reaction with organic materials (in kg NMVOC eq)
Relative available water remaining per area in a watershed, after the demand of humans and aquatic ecosystems has been met. It assesses the potential of water deprivation, to either humans or ecosystems, building on the assumption that the less water remaining available per area (in m^3 eq)
Ability to effectively recycle waste from identical or similar products
The Traceability Score of a product represents the degree of knowledge of its value chain. We estimate the number of manufacturing steps required to produce the item and its main components and we evaluate the number of known suppliers within this theoretical value chain
A list of minimal information on links related to this study
A list of packagings linked to this study
Percentage of the packaging that is made from recycled matter
Possibility of re-use of the packaging
Enum"N/A""NO - 0""YES - REFILLABLE""YES - REUSABLE"
Recyclability of the packaging: Taxonomy to be respected
Enum"N/A""NO - 0""YES - FULLY RECYCLING""YES - FULLY RECYCLING + RECYCLABLE IN THE SAME TYPE OF PACKAGING""YES - MOSTLY RECYCLING"
Example: {"en":"Box","fr":"Boîte","es":"Caja"}
AGEC Claim : Recycled matter presence in the packaging
Response
application/json
{ "id": "string", "state": "PLANNED", "brandCollectionName": "string", "category": "string", "productRef": "string", "colorCode": "string", "projectType": "string", "purchaseOrder": "string", "showcaseLinks": "string", "weight": 0, "ecoModulation": "string", "picture": "string", "product": { "id": "string", "ref": "string", "name": "string", "publicName": "string", "certifications": [ … ] }, "components": [ { … } ], "results": { "resourceUseMineralsMetals": 0, "resourceUseFossils": 0, "acidification": 0, "humanToxicityCancer": 0, "humanToxicityNonCancer": 0, "eutrophicationFreshWater": 0, "eutrophicationMarine": 0, "eutrophicationTerrestrial": 0, "climateChange": 0, "climateChangeBiogenic": 0, "climateChangeFossil": 0, "climateChangeLandUse": 0, "ionisingRadiation": 0, "landuse": 0, "ozoneDepletion": 0, "particulateMatter": 0, "photochemicalOzoneFormation": 0, "waterUse": 0, "recycledMaterialsPercentage": 0, "microplasticPercentage": 0, "climateChangeEquivalence": {}, "eutrophicationFreshWaterEquivalence": {}, "resourceUseFossilsEquivalence": {}, "grades": { … }, "frenchSingleScore": 0, "frenchSingleScorePerUnitWeight": 0, "frenchSingleScoreDetails": { … }, "ecotoxicityFreshWater": 0 }, "links": [ { … } ], "showcaseTexts": { "materialTextDescription": {}, "recyclabilityTextDescription": {}, "descriptionACV": {}, "descriptionACVSpecific": {} }, "packaging": [ { … } ], "agecClaims": { "ecoModulation": {}, "microfibers": {}, "recycledMaterials": {} } }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies/{id}/details
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/studies/{id}/details
- Production Server
https://api.fairlymade.com/v2/studies/{id}/details
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies/{id}/details?lang=fr' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Bodyapplication/json
Last known state of study's progress
Enum"PLANNED""REVIEWED""ARCHIVED""PUBLISHED""COMPLETED""IN_PROGRESS""CANCELLED"
List of certifications tied to this product
A list of components linked to this study
General composition of the component separated by semi-colons
A list of material used to make the component
Percentage of this material the parent component is made of
components[].composition[].traceability_stepsArray of objects(TraceabilityStepFormatShowcase)required
A list of traceability steps making a full branch from this material to the upmost parent (should be product)
Unique identifier of this traceability step
Three sets of numbers going from 001 to 999, giving the absolute position of the traceability step in the tree
Icon attached to the traceability step
components[].composition[].traceability_steps[].transportsArray of objects(TraceabilityStepTransportDto)required
List of all means of transportation travelling from this traceability step
Default transportation type assigned
City of this supplier
Country of this supplier
Region of this supplier
components[].composition[].traceability_steps[].supplier.socialCertificationsArray of objects(CertificationFormatShowcase)required
List of social certifications this supplier has
components[].composition[].traceability_steps[].supplier.environmentalCertificationsArray of objects(CertificationFormatShowcase)required
List of environmental certifications this supplier has
Indicates if the supplier is known by the system
Example: {"en":"Paddings","fr":"Rembourrage","es":"Acolchado"}
EF impact category that addresses the use of non-renewable abiotic natural resources (minerals and metals) (in kg Sb eq)
EF impact category that addresses the use of non-renewable fossil natural resources (e.g. natural gas, coal, oil) (in MJ)
Impacts due to acidifying substances in the environment. The protons contribute to the acidification of soils and water when they are released in areas where the buffering capacity is low, resulting in forest decline and lake acidification (in mol H+ eq)
EF impact category that accounts for adverse health effects on human beings caused by the intake of toxic substances through inhalation of air, food/water ingestion, penetration through the skin insofar as they are related to cancer (in CTUh)
EF impact category that accounts for the adverse health effects on human beings caused by the intake of toxic substances through inhalation of air, food/water ingestion, penetration through the skin insofar as they are related to non-cancer effects (in CTUh)
Nutrients from sewage outfalls and fertilised farmland accelerate the growth of algae and other vegetation in water. The degradation of organic material consumes oxygen resulting in oxygen deficiency and, in some cases, fish death (in kg P eq)
Nutrients from sewage outfalls and fertilised farmland accelerate the growth of algae and other vegetation in water. The degradation of organic material consumes oxygen resulting in oxygen deficiency and, in some cases, fish death (in kg N eq)
Nutrients from sewage outfalls and fertilised farmland accelerate the growth of algae and other vegetation in water. The degradation of organic material consumes oxygen resulting in oxygen deficiency and, in some cases, fish death (in mol N eq)
All inputs or outputs that result in greenhouse gas emissions. The consequences include increased average global temperatures and sudden regional climatic changes. Climate change is an impact affecting the environment on a global scale (in kg CO2 eq)
EF impact category that accounts for the adverse health effects on human health caused by radioactive releases (in kBq U235 eq)
Use (occupation) and conversion (transformation) of land area by activities such as agriculture, forestry, roads, housing, mining, etc. (in points)
Degradation of stratospheric ozone due to emissions of ozone-depleting substances, for example long-lived chlorine and bromine containing gases (e.g. CFCs, HCFCs, Halons) (in kg CFC^-11 eq)
EF impact category that accounts for the adverse health effects on human health caused by emissions of Particulate Matter (PM) and its precursors (NOx, SOx, NH3) (Diseace Incidence)
Formation of ozone at the ground level of the troposphere caused by photochemical oxidation of volatile organic compounds (VOCs). High concentrations of ground-level tropospheric ozone damage vegetation, human respiratory tracts and manmade materials through reaction with organic materials (in kg NMVOC eq)
Relative available water remaining per area in a watershed, after the demand of humans and aquatic ecosystems has been met. It assesses the potential of water deprivation, to either humans or ecosystems, building on the assumption that the less water remaining available per area (in m^3 eq)
Ability to effectively recycle waste from identical or similar products
The Traceability Score of a product represents the degree of knowledge of its value chain. We estimate the number of manufacturing steps required to produce the item and its main components and we evaluate the number of known suppliers within this theoretical value chain
A list of minimal information on links related to this study
A list of packagings linked to this study
Percentage of the packaging that is made from recycled matter
Possibility of re-use of the packaging
Enum"N/A""NO - 0""YES - REFILLABLE""YES - REUSABLE"
Recyclability of the packaging: Taxonomy to be respected
Enum"N/A""NO - 0""YES - FULLY RECYCLING""YES - FULLY RECYCLING + RECYCLABLE IN THE SAME TYPE OF PACKAGING""YES - MOSTLY RECYCLING"
Example: {"en":"Box","fr":"Boîte","es":"Caja"}
AGEC Claim : Recycled matter presence in the packaging
Response
application/json
{ "id": "string", "state": "PLANNED", "brandCollectionName": "string", "category": "string", "productRef": "string", "colorCode": "string", "projectType": "string", "purchaseOrder": "string", "showcaseLinks": "string", "weight": 0, "ecoModulation": "string", "picture": "string", "product": { "id": "string", "ref": "string", "name": "string", "publicName": "string", "certifications": [ … ] }, "components": [ { … } ], "results": { "resourceUseMineralsMetals": 0, "resourceUseFossils": 0, "acidification": 0, "humanToxicityCancer": 0, "humanToxicityNonCancer": 0, "eutrophicationFreshWater": 0, "eutrophicationMarine": 0, "eutrophicationTerrestrial": 0, "climateChange": 0, "climateChangeBiogenic": 0, "climateChangeFossil": 0, "climateChangeLandUse": 0, "ionisingRadiation": 0, "landuse": 0, "ozoneDepletion": 0, "particulateMatter": 0, "photochemicalOzoneFormation": 0, "waterUse": 0, "recycledMaterialsPercentage": 0, "microplasticPercentage": 0, "climateChangeEquivalence": {}, "eutrophicationFreshWaterEquivalence": {}, "resourceUseFossilsEquivalence": {}, "grades": { … }, "frenchSingleScore": 0, "frenchSingleScorePerUnitWeight": 0, "frenchSingleScoreDetails": { … }, "ecotoxicityFreshWater": 0 }, "links": [ { … } ], "showcaseTexts": { "materialTextDescription": {}, "recyclabilityTextDescription": {}, "descriptionACV": {}, "descriptionACVSpecific": {} }, "packaging": [ { … } ], "agecClaims": { "ecoModulation": {}, "microfibers": {}, "recycledMaterials": {} } }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies/{id}/showcase
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/studies/{id}/showcase
- Production Server
https://api.fairlymade.com/v2/studies/{id}/showcase
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies/{id}/showcase?lang=en' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Bodyapplication/json
Array [
Percentage of this material the parent component is made of
components[][].composition[].traceability_stepsArray of objects(TraceabilityStepFormatShowcase)required
A list of traceability steps making a full branch from this material to the upmost parent (should be product)
Unique identifier of this traceability step
Name of the traceability step
Three sets of numbers going from 001 to 999, giving the absolute position of the traceability step in the tree
Icon attached to the traceability step
components[][].composition[].traceability_steps[].transportsArray of objects(TraceabilityStepTransportDto)required
List of all means of transportation travelling from this traceability step
Default transportation type assigned
Current status for this certification
Enum"NOT_VERIFIED""CAUTION""VALIDATED""EXPIRED"
Response
application/json
{ "name": "string", "publicName": "string", "type": "string", "color": "string", "picture": "string", "sku": "string", "components": [ [ … ] ], "grades": { "recyclability": 0, "traceability": 0 }, "productCertifications": [ { … } ], "impacts": { "descriptionACVSpecific": {}, "descriptionACV": {}, "materialTextDescription": {}, "recyclabilityTextDescription": {}, "climateChange": 0, "climateChangeEquivalence": {}, "eutrophicationFreshWater": 0, "eutrophicationFreshWaterEquivalence": {}, "resourceUseFossils": 0, "resourceUseFossilsEquivalence": {}, "publicProductNames": {}, "ecoContribution": "string", "recycledMaterialsPercentage": 0, "microplasticPercentage": 0, "hazardousSubstancesTextDescription": {}, "frenchSingleScore": 0, "frenchSingleScorePerUnitWeight": 0, "frenchSingleScoreDetails": { … } }, "hasDurability": true, "studyType": "string", "packaging": [ { … } ], "agecClaims": { "ecoModulation": {}, "microfibers": {}, "recycledMaterials": {} }, "state": "string" }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies/list-studies
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/studies/list-studies
- Production Server
https://api.fairlymade.com/v2/studies/list-studies
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/studies/list-studies?state=string&collectionRef=string&productRef=string&colorCode=string&dateStart=string&dateEnd=string&limit=20&offset=0&sortBy=string&sortDesc=true' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/suppliers
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/suppliers
- Production Server
https://api.fairlymade.com/v2/suppliers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/suppliers?limit=20&offset=0&sortBy=string&sortDesc=true&search=string' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Response
application/json
{ "offset": 0, "limit": 20, "total": 0, "data": [ { … } ] }
- Mock server
https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/suppliers/{id}
- Sandbox Server
https://sandbox.api.fairlymade.com/v2/suppliers/{id}
- Production Server
https://api.fairlymade.com/v2/suppliers/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/suppliers/{id}' \
-H 'Authorization: Bearer <YOUR_Bearer _HERE>'Response
application/json
{ "id": "string", "supplierRef": [ "string" ], "name": "string", "type": "string", "createdAt": "2019-08-24T14:15:22Z", "address": { "label": "Home", "street": "1st street", "additionalStreet": "2nd street", "city": "Paris", "administrativeArea": "Ile-de-France", "postalCode": "75000", "country": "CN", "region": "Asia" }, "factory_performances": { "productionCapacity": "string", "losses": 0, "greenElectricityEquipmentPercentage": 0, "electricityConsumptionPerMonth": 0, "inHouseEffluentPercentage": 0, "transportations": [ … ], "hasProgramImpactParticipation": true, "heatType": "string", "hasGreenElectricityEquipment": true, "greenElectricityEquipmentKind": "string", "hasInHouseEffluentTreatmentSystem": true, "inHouseEffluentKind": "string", "hasEnergyEfficientInvestment": true, "energyEfficientKind": "string", "hasWashedAfterManufacturing": true, "washedAfterManufacturingLaundry": "string" }, "details": { "nb_employees": 0, "website": "string", "contactEmail": "string" }, "contacts": [ { … } ], "category": "string", "certifications": [ { … } ] }