Skip to content

FairlyMade API (2.0)

Overview

This API was created by Fairly Made to allow you to send your data needed for analyzes. If you need further information about it, please kindly contact your Fairly Made referents.

Download OpenAPI description
swagger-public-v2.json
swagger-public-v2.yaml
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/

Authentication

You were provided a token by your Fairly Made referent, please use this token as a Bearer token to use the API

Routes documentation

For each route you can find the expected body with its required fields, the response payload and status code. Do not hesitate to use the arrows (>) on request body schemas and the plus sign (+) on the response payload to see more details.

STANDARD

Operations

AGEC

Operations

AGEC NO FDC

Operations

AGEC Packaging Only

Operations

Create Component *

Request

AGEC with Packaging Only

Bodyapplication/jsonrequired
projectTypestringrequired

The project type

Value"AGEC_PACKAGING_ONLY"
Example: "AGEC_PACKAGING_ONLY"
componentRefstringrequired

Unique component reference code used in your system

supplierComponentCodestring

The code/name of the reference of the supplier you use to discuss

lotReferencesArray of strings

Lot Number (Batch), used to identify different traceability paths on a single component

Example: ["B57A","B57B"]
productCollectionRefstringrequired

Collection name used in your system linked to the product

productRefstringrequired

Product unique Id/Ref used in your system linked to this component

productColorCodeobject

Unique color reference/name of the product

Default "DEFAULT"
componentPrintboolean

Is the component printed ?

Example: true
typestring

Type of the component. If you do not know it, use 'OTHER'. Taxonomy to be respected

Enum"LEATHER""METAL""OTHER""PLASTIC""TEXTILE""WOOD"
categorystring

Category of the component: Taxonomy to be respected

Enum"ANIMAL""BACKINGS/COUNTERS""BELT LOOPS""BIAS STRIPS""BRA CLIPS""BUCKLES""BUTTINETTES""BUTTONS""CHAIN""CLAMPING TABS"
Example: "MAIN FABRIC (WOVEN)"
compositionArray of objects(ComponentCompositionV2Public)

The list of raw materials that make this component, along with their percentage, country of origin and list of certifications

Example: [{"material":"ORGANIC COTTON","percentage":64.5},{"material":"RECYCLED POLYESTER","percentage":35.5}]
printingCountrystring

ISO 3166-1 Alpha-2: Code of the country where the component is printed

Example: "FR"
dyeingCountrystring

ISO 3166-1 Alpha-2: Code of the country where the component is dyed

Example: "FR"
knittingCountrystring

ISO 3166-1 Alpha-2: Knitting country

Example: "FR"
weavingCountrystring

ISO 3166-1 Alpha-2: Weaving country

Example: "FR"
shoeFinishingCountrystring

ISO 3166-1 Alpha-2: Finishing country, for shoe components

Example: "FR"
shoeStitchingCountrystring

ISO 3166-1 Alpha-2: Stitching country, for shoe components

Example: "FR"
componentWeightnumber

Weights in grams of the component in the linked product

certificationsArray of objects(UploadComponentsCertificationPublicDto)

Certifications of the component: Taxonomy to be respected

importationBatchstringrequired

Unique designation of a batch of data pushed. It can be a date, a number or another format decided with your Fairly Made referent.

supplierRefstring

Code or reference of the supplier in your internal systems

curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/agec-packaging/components \
  -H 'Content-Type: application/json' \
  -d '{
    "projectType": "AGEC_PACKAGING_ONLY",
    "componentRef": "string",
    "supplierComponentCode": "string",
    "lotReferences": [
      "B57A",
      "B57B"
    ],
    "productCollectionRef": "string",
    "productRef": "string",
    "productColorCode": "DEFAULT",
    "componentPrint": true,
    "type": "LEATHER",
    "category": "MAIN FABRIC (WOVEN)",
    "composition": [
      {
        "material": "ORGANIC COTTON",
        "percentage": 64.5
      },
      {
        "material": "RECYCLED POLYESTER",
        "percentage": 35.5
      }
    ],
    "printingCountry": "FR",
    "dyeingCountry": "FR",
    "knittingCountry": "FR",
    "weavingCountry": "FR",
    "shoeFinishingCountry": "FR",
    "shoeStitchingCountry": "FR",
    "componentWeight": 0,
    "certifications": [
      {
        "date_start": "2019-08-24T14:15:22Z",
        "type": "ABELUSI WOOL",
        "date_end": "string",
        "file": "string"
      }
    ],
    "importationBatch": "string",
    "supplierRef": "string"
  }'

Responses

Bodyapplication/json
successboolean
Enumtruefalse
idstring
Example: "id"
Response
application/json
{
  "success": true,
  "id": "id"
}

Create Packaging

Request

AGEC with Packaging Only

Bodyapplication/jsonrequired
packagingRefstringrequired

Unique packaging reference code used in your system

typestringrequired

Type of packaging: Taxonomy to be respected.

Enum"BOX""CARDBOARD_SHEET""CASE""CRYSTAL_POCKET""DELIVERY BOX""DOYPACK""DUST BAG/POUCH""ENVELOPE""FILLER""GARMENT_BAG"
Example: "POLYBAG"
channelstringrequired

The distribution channel where the packaging is used: Taxonomy to be respected.

Enum"BOTH""E-COMMERCE""FACTORY_TO_CONSUMER""STORE"
Example: "BOTH"
percentageRecyclednumber[ 0 .. 100 ]required

Percentage of recycled material present in the packaging

Example: 20
ecoModulationArray of stringsrequired

Eco-modulation linked to this packaging: Taxonomy to be respected.

Items Enum"BONUS -4% OFF-PACK - AWARENESS CAMPAIGN MEDIA""BONUS -8% REDUCTION AT SOURCE - REDUCTION OF THE NUMBER OF UNITS""BONUS -8% REDUCTION AT SOURCE - REDUCTION OF WEIGHT""BONUS -8% REDUCTION AT SOURCE - REFILLABLE RECYCLED CONTAINER""MALUS +10% - RIGID PE/PP BOTTLE DENSITY < 1""MALUS +10% - RIGID PET BOTTLE DENSITY < 1 AND DENSITY >1""MALUS +100% - ARMED PAPER/CARDBOARD""MALUS +100% - GLASS OTHER THA SODA LIME""MALUS +100% - GLASS WITH SODA LIME WITH INFUSIBLE ELEMENT""MALUS +100% - OPAQUE PET BOTTLE MINERAL FILLER > 4%"
compostabilitystringrequired

Compostability of the packaging: Taxonomy to be respected.

Enum"N/A""NO - 0""YES - COMPOSTABLE"
Example: "YES - COMPOSTABLE"
recyclabilitystringrequired

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: "YES - FULLY RECYCLING"
possibilityReUsestringrequired

Possibility of re-use of the packaging: Taxonomy to be respected

Enum"N/A""NO - 0""YES - REFILLABLE""YES - REUSABLE"
Example: "YES - REUSABLE"
hazardousSubstancesobjectrequired
Example: {"status":"UNKNOWN"}
hazardousSubstances.​statusstringrequired

Status of hazardous substances

Enum"YES""NO""UNKNOWN"
Example: "UNKNOWN"
hazardousSubstances.​valuestring

You can pinpoint the exact hazardous substance.

importationBatchstringrequired

import id to identify the data import wave. It can be a date, a number or another format decided with your Fairly Made referent.

projectTypestringrequired

The project type

Value"AGEC_PACKAGING_ONLY"
Example: "AGEC_PACKAGING_ONLY"
curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/agec-packaging/packaging \
  -H 'Content-Type: application/json' \
  -d '{
    "packagingRef": "string",
    "type": "POLYBAG",
    "channel": "BOTH",
    "percentageRecycled": 20,
    "ecoModulation": [
      "BONUS -4% OFF-PACK - AWARENESS CAMPAIGN MEDIA"
    ],
    "compostability": "YES - COMPOSTABLE",
    "recyclability": "YES - FULLY RECYCLING",
    "possibilityReUse": "YES - REUSABLE",
    "hazardousSubstances": {
      "status": "UNKNOWN"
    },
    "importationBatch": "string",
    "projectType": "AGEC_PACKAGING_ONLY"
  }'

Responses

Bodyapplication/json
successbooleanrequired
packagingIdstringrequired
packagingRefArray of objectsrequired
importationBatchstringrequired
projectTypestringrequired
Response
application/json
{
  "success": true,
  "packagingId": "string",
  "packagingRef": [
    {}
  ],
  "importationBatch": "string",
  "projectType": "string"
}

Create Product

Request

AGEC with Packaging Only

Security
bearer
Bodyapplication/jsonrequired
projectTypestringrequired

The project type

Value"AGEC_PACKAGING_ONLY"
Example: "AGEC_PACKAGING_ONLY"
namestring

Name of the product (will appear on the platform)

publicNamestring

The public name of your product (used in our showcase)

productRefstringrequired

Unique product reference code used in your system

purchaseOrderstring

Products purchase order.

picturestring

URL link of the product’s picture

categorystringrequired

Category of the product. If no type matches, use 'OTHER': Taxonomy to be respected

Enum"ACCESSORIES""APRONS""BACKPACKS""BATHROBES""BATH_MATS""BATH_TOWELS""BEACH_TOWELS""BELTS""BIBS & BRACES""BIKINIS"
productCollectionRefstringrequired

Name of the product's collection

productColorCodeobject

Unique color reference/name of the product

Default "DEFAULT"
weightnumber

Weight of the product in grams. Should be between 5g et 10000g

compositionstring

Composition of the product

Example: "65% ORGANIC COTTON, 25% NIPOL®, 10% RECYCLED LOW DENSITY POLYETHYLENE"
producedQuantitynumber

Number of pieces produced over one year.

packagingRefsArray of strings

Code or reference of the packaging used in your internal systems.

certificationsArray of objects(UploadProductsCertificationPublicDto)

Certificates/labels that the product (not the material ones). Has Taxonomy to be respected.

manufacturingAssemblyCountryArray of strings

ISO 3166-1 Alpha-2: Manufacturing assembly country

Example: "FR"
destinationMarketstring

Geographical area where the product will be sold. Taxonomy is to be respected.

Enum"AFRICA""AMERICA""ASIA""EUROPE""MIDDLE EAST""OCEANIA"
Example: "AMERICA"
transportTypeToDestMarketstring

Usual means of transportation used for the product

Enum"BARGE""BOAT""CAR""PLANE""TRAIN""TRUCK""VAN"
Example: "BOAT"
warehouseRefstring

Code or reference name of your main warehouse (warehouses are to be referenced as a supplier). Must be already sent.

reachCompliancenumber

Is the product Reach compliant? yes/1, no/0

Enum01
Example: 1
ecoModulationstring

Eco-Modulation linked to this product: Taxonomy to be respected

Enum"ECOLOGIC ASL - CRITERIA 1 + 2""ECOLOGIC ASL - CRITERIA 1 + 2 + 3""ECOLOGIC ASL - CRITERIA 1 + 3""ECOLOGIC ASL - CRITERIA 1 - SPARE PARTS AVAILABILITY >10 YEARS""ECOLOGIC ASL - CRITERIA 2 + 3""ECOLOGIC ASL - CRITERIA 2 - SPARE PARTS TIME > 7 DAYS""ECOLOGIC ASL - CRITERIA 3 - INTEGRATION OF RECYCLED MATERIALS > 40%.""NONE""REFASHION TLC - ECO-MODULATION 1 - DURABILITY""REFASHION TLC - ECO-MODULATION 2 - ENVIRONMENTAL LABELS"
importationBatchstringrequired

import id to identify the data import wave. It can be a date, a number or another format decided with your Fairly Made referent.

supplierRefstring

Code or reference of the supplier in your internal systems. Must be already sent.

projectImpactobject
curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/agec-packaging/products \
  -H 'Authorization: Bearer <YOUR_Bearer _HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "projectType": "AGEC_PACKAGING_ONLY",
    "name": "string",
    "publicName": "string",
    "productRef": "string",
    "purchaseOrder": "string",
    "picture": "string",
    "category": "ACCESSORIES",
    "productCollectionRef": "string",
    "productColorCode": "DEFAULT",
    "weight": 0,
    "composition": "65% ORGANIC COTTON, 25% NIPOL®, 10% RECYCLED LOW DENSITY POLYETHYLENE",
    "producedQuantity": 0,
    "packagingRefs": [
      "string"
    ],
    "certifications": [
      {
        "date_start": "2019-08-24T14:15:22Z",
        "type": "ABELUSI WOOL",
        "date_end": "string",
        "file": "string"
      }
    ],
    "manufacturingAssemblyCountry": "FR",
    "destinationMarket": "AMERICA",
    "transportTypeToDestMarket": "BOAT",
    "warehouseRef": "string",
    "reachCompliance": 1,
    "ecoModulation": "ECOLOGIC ASL - CRITERIA 1 + 2",
    "importationBatch": "string",
    "supplierRef": "string",
    "projectImpact": {}
  }'

Responses

Bodyapplication/json
successbooleanrequired
projectTypestringrequired
productIdstringrequired
studyIdstringrequired
productRefArray of objectsrequired
namestringrequired
productColorCodestringrequired
qrCodeLinkstringrequired
showcaseLinkstringrequired
importationBatchstringrequired
Response
application/json
{
  "success": true,
  "projectType": "string",
  "productId": "string",
  "studyId": "string",
  "productRef": [
    {}
  ],
  "name": "string",
  "productColorCode": "string",
  "qrCodeLink": "string",
  "showcaseLink": "string",
  "importationBatch": "string"
}

Create Supplier *

Request

AGEC with Packaging only

Security
bearer
Bodyapplication/jsonrequired
projectTypestringrequired

The project type

Value"AGEC_PACKAGING_ONLY"
Example: "AGEC_PACKAGING_ONLY"
namestring

Supplier's name

supplierRefstringrequired

Unique Supplier's reference code used in your systems

categorystringrequired

Supplier's main category or activity. Taxonomy to be respected.

Enum"MANUFACTURING - Leather Goods""MANUFACTURING - Other""MANUFACTURING - Ready To Wear""MANUFACTURING - Shoe""MANUFACTURING - Shoe Finishing""MANUFACTURING - Shoe Stitching""OTHER - Agent/Buying Office""OTHER - Packaging""OTHER - Warehouse""OTHER - Wholesaler"
addressobject
contactsArray of objects(SupplierContactDto)

Contacts of the supplier

certificationsArray of objects(UploadSuppliersCertificationPublicDto)

Certifications of the supplier. Has Taxonomy to be respected.

importationBatchstringrequired

import id to identify the data import wave. It can be a date, a number or another format decided with your Fairly Made referent.

additionalInformationstring

Additional useful informations about the supplier.

curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/agec-packaging/suppliers \
  -H 'Authorization: Bearer <YOUR_Bearer _HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "projectType": "AGEC_PACKAGING_ONLY",
    "name": "string",
    "supplierRef": "string",
    "category": "MANUFACTURING - Leather Goods",
    "address": {
      "label": "Home",
      "street": "1st street",
      "additionalStreet": "2nd street",
      "city": "Paris",
      "administrativeArea": "Ile-de-France",
      "postalCode": "75000",
      "country": "CN",
      "region": "Asia"
    },
    "contacts": [
      {
        "person": {
          "firstname": "John",
          "name": "Doe",
          "language": "fr",
          "phone": "0123456789",
          "email": "[email protected]"
        }
      }
    ],
    "certifications": [
      {
        "date_start": "2019-08-24T14:15:22Z",
        "type": "4SUSTAINABILITY CHEM ADVANCED",
        "date_end": "string",
        "file": "string"
      }
    ],
    "importationBatch": "string",
    "additionalInformation": "string"
  }'

Responses

Bodyapplication/json
successbooleanrequired
idstringrequired
importationBatchstringrequired
projectTypestringrequired
Response
application/json
{
  "success": true,
  "id": "string",
  "importationBatch": "string",
  "projectType": "string"
}

MODULE E360

Operations

MODULE E360 AGEC

Operations

Accounts

Operations

Collections

Operations

Get all packaging

Request

Query
limitnumber

The number of items to return.

Default 20
offsetnumber

The number of items to skip before starting to collect the result.

Default 0
sortByArray of strings

Sort the results by the specified field(s).

sortDescArray of booleans

Sort the results in descending order. (true for descending, false for ascending)

searchstring
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'

Responses

Bodyapplication/json
offsetnumber

The number of items skiped before starting to collect the result.

Default 0
limitnumber

The number of items to return.

Default 20
totalnumber

The total number of items.

dataArray of objects(PackagingFormatOutputAll)

The list of items.

Response
application/json
{
  "offset": 0,
  "limit": 20,
  "total": 0,
  "data": [
    { … }
  ]
}

Get packaging details

Request

Path
idstringrequired

Fairly Made's Packaging Id or your packagingRef

curl -i -X GET \
  'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/packaging/{id}'

Responses

Bodyapplication/json
idstringrequired
packagingRefstringrequired
typestringrequired
Response
application/json
{
  "id": "string",
  "packagingRef": "string",
  "type": "string"
}

Get all brand products

Request

Security
bearer
Query
limitnumber

The number of items to return.

Default 20
offsetnumber

The number of items to skip before starting to collect the result.

Default 0
sortByArray of strings

Sort the results by the specified field(s).

sortDescArray of booleans

Sort the results in descending order. (true for descending, false for ascending)

searchstring
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>'

Responses

Bodyapplication/json
offsetnumber

The number of items skiped before starting to collect the result.

Default 0
limitnumber

The number of items to return.

Default 20
totalnumber

The total number of items.

dataArray of objects(ProductFormatOutputAll)

The list of items.

Response
application/json
{
  "offset": 0,
  "limit": 20,
  "total": 0,
  "data": [
    { … }
  ]
}

Get product details

Request

Security
bearer
Path
idstringrequired

Fairly Made's product id or your product's ref

curl -i -X GET \
  'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/products/{id}' \
  -H 'Authorization: Bearer <YOUR_Bearer _HERE>'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of this product

refArray of stringsrequired

A list of external references identifying this product

namestringrequired

The name of the product

categorystringrequired

The category of the product

studiesArray of objects(StudyV2FormatOutputMin)required

A list of studies' extracts linked to this product

studies[].​idstringrequired

Unique identifier of this study

studies[].​productRefstringrequired

Reference code of the study

studies[].​colorCodestringrequired

Color code of the study

studies[].​picturestringrequired

A link to the study's picture

studies[].​brandCollectionobjectrequired
studies[].​brandCollection.​idstringrequired

Unique identifier of this brand collection

studies[].​brandCollection.​namestringrequired

Name of the brand collection

studies[].​linksArray of objects(LinkFormatPublicOutputMin)required

A list of minimal information on links related to this study

studies[].​links[].​idstringrequired

Unique identifier of this link

studies[].​links[].​linkstringrequired

URL pointing to an HTTP ressource

studies[].​links[].​typestringrequired

Type of the link

studies[].​statestringrequired

The current study's state

Enum"PLANNED""REVIEWED""ARCHIVED""PUBLISHED""COMPLETED""IN_PROGRESS""CANCELLED"
Response
application/json
{
  "id": "string",
  "ref": [
    "string"
  ],
  "name": "string",
  "category": "string",
  "studies": [
    { … }
  ]
}

Get study details

Request

Security
bearer
Query
langArray of strings

Languages for AGEC Claims translations

Items Enum"fr""en""es""it"
collectionRefstringrequired

The brand collection reference

productRefstringrequired

The product reference

colorCodestringrequired

The product's color code

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>'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of this study

statestringrequired

Last known state of study's progress

Enum"PLANNED""REVIEWED""ARCHIVED""PUBLISHED""COMPLETED""IN_PROGRESS""CANCELLED"
brandCollectionNamestringrequired

Name of the brand collection the study belongs to

categorystringrequired

Category of the study

productRefstringrequired

Product reference

colorCodestringrequired

Color code of the study

projectTypestringrequired

The type of project the study belongs to

purchaseOrderstringrequired

Purchase order the study is linked to

showcaseLinksstringrequired

A list of links to showcases separated by semi-colons

weightnumberrequired

Weight in grams of the product

ecoModulationstringrequired

Eco contribution information

picturestringrequired

A link to the study's picture

productobjectrequired
product.​idstringrequired

Unique identifier of this product

product.​refstringrequired

Reference code of the product

product.​namestringrequired

Name of the product

product.​publicNamestringrequired

Public name of the product usually displayed on public ressources

product.​certificationsArray of objects(CertificationV2FormatOutputMin)required

List of certifications tied to this product

product.​certifications[].​namestringrequired
product.​certifications[].​statusstringrequired
Enum"NOT_VERIFIED""CAUTION""VALIDATED""EXPIRED"
product.​certifications[].​isVisiblebooleanrequired
componentsArray of objects(ComponentV2FormatOutput)required

A list of components linked to this study

components[].​refstringrequired

Ref of the component

components[].​supplierCodestringrequired

Supplier reference code linked to the component

components[].​lotReferencesArray of stringsrequired

A list of batch reference

components[].​typestringrequired

Type of component

components[].​generalCompositionstringrequired

General composition of the component separated by semi-colons

components[].​namestringrequired

Name of the component

components[].​categorystringrequired

Category of the component

components[].​compositionArray of objects(MaterialFormatShowcase)required

A list of material used to make the component

components[].​composition[].​idstringrequired

Unique identifier of the material

components[].​composition[].​percentagenumberrequired

Percentage of this material the parent component is made of

components[].​composition[].​raw_materialstringrequired

Name of its raw material

components[].​composition[].​raw_material_smcpstringrequired

Specific raw material name for SMCP

components[].​composition[].​materialTranslationsobjectrequired
components[].​composition[].​materialTranslations.​enstring
components[].​composition[].​materialTranslations.​frstring
components[].​composition[].​materialTranslations.​esstring
components[].​composition[].​materialTranslations.​itstring
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)

components[].​composition[].​traceability_steps[].​idstringrequired

Unique identifier of this traceability step

components[].​composition[].​traceability_steps[].​namestringrequired

Name of the traceability step

components[].​composition[].​traceability_steps[].​positionstringrequired

Three sets of numbers going from 001 to 999, giving the absolute position of the traceability step in the tree

components[].​composition[].​traceability_steps[].​iconstringrequired

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

components[].​composition[].​traceability_steps[].​transports[].​typestringrequired

Type of this transport

components[].​composition[].​traceability_steps[].​transports[].​distancenumberrequired

Distance travelled with this transport

components[].​composition[].​traceability_steps[].​transportationTypestring

Default transportation type assigned

components[].​composition[].​traceability_steps[].​supplierobjectrequired
components[].​composition[].​traceability_steps[].​supplier.​refstring

Reference of this supplier

components[].​composition[].​traceability_steps[].​supplier.​citystringrequired

City of this supplier

components[].​composition[].​traceability_steps[].​supplier.​countrystringrequired

Country of this supplier

components[].​composition[].​traceability_steps[].​supplier.​regionstringrequired

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

components[].​composition[].​traceability_steps[].​supplier.​isKnownbooleanrequired

Indicates if the supplier is known by the system

components[].​composition[].​traceability_steps[].​supplier.​namestring

The name of this supplier

components[].​composition[].​traceability_steps[].​supplier.​idstring

The unique identifier of this supplier

components[].​composition[].​traceability_steps[].​kmToNextnumberrequired

Number of kilometers separating this traceability step and the next one

components[].​weightnumberrequired

Weight of the component

components[].​categoryTranslationsobjectrequired
Example: {"en":"Paddings","fr":"Rembourrage","es":"Acolchado"}
components[].​categoryTranslations.​enstring
Example: "Paddings"
components[].​categoryTranslations.​frstring
Example: "Rembourrage"
components[].​categoryTranslations.​esstring
Example: "Acolchado"
components[].​categoryTranslations.​itstring
resultsobjectrequired
results.​resourceUseMineralsMetalsnumberrequired

EF impact category that addresses the use of non-renewable abiotic natural resources (minerals and metals) (in kg Sb eq)

results.​resourceUseFossilsnumberrequired

EF impact category that addresses the use of non-renewable fossil natural resources (e.g. natural gas, coal, oil) (in MJ)

results.​acidificationnumberrequired

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)

results.​humanToxicityCancernumberrequired

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)

results.​humanToxicityNonCancernumberrequired

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)

results.​eutrophicationFreshWaternumberrequired

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)

results.​eutrophicationMarinenumberrequired

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)

results.​eutrophicationTerrestrialnumberrequired

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)

results.​climateChangenumberrequired

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)

results.​climateChangeBiogenicnumberrequired
results.​climateChangeFossilnumberrequired
results.​climateChangeLandUsenumberrequired
results.​ionisingRadiationnumberrequired

EF impact category that accounts for the adverse health effects on human health caused by radioactive releases (in kBq U235 eq)

results.​landusenumberrequired

Use (occupation) and conversion (transformation) of land area by activities such as agriculture, forestry, roads, housing, mining, etc. (in points)

results.​ozoneDepletionnumberrequired

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)

results.​particulateMatternumberrequired

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)

results.​photochemicalOzoneFormationnumberrequired

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)

results.​waterUsenumberrequired

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)

results.​recycledMaterialsPercentagenumberrequired
results.​microplasticPercentagenumberrequired
results.​climateChangeEquivalenceobjectrequired
results.​eutrophicationFreshWaterEquivalenceobjectrequired
results.​resourceUseFossilsEquivalenceobjectrequired
results.​gradesobjectrequired
results.​grades.​recyclabilitynumberrequired

Ability to effectively recycle waste from identical or similar products

results.​grades.​traceabilitynumberrequired

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

results.​grades.​compliancenumberrequired

Average of the social performance of the various stakeholders in the value chain associated with it

results.​frenchSingleScorenumberrequired
results.​frenchSingleScorePerUnitWeightnumberrequired

French Single Score per unit weight

results.​frenchSingleScoreDetailsobjectrequired
results.​frenchSingleScoreDetails.​brandScorenumberrequired

Score of the brand

results.​frenchSingleScoreDetails.​productScorenumberrequired

Score of the product

results.​frenchSingleScoreDetails.​frenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​malusBonusServiceDurationnumberrequired
results.​frenchSingleScoreDetails.​referenceServiceDurationnumberrequired
results.​frenchSingleScoreDetails.​adjustedServiceDurationnumberrequired
results.​frenchSingleScoreDetails.​lcaFrenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​ooeuExportFrenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​microfibersFrenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​productRangeCoefficientnumberrequired
results.​frenchSingleScoreDetails.​repairPromotionCoefficientnumberrequired
results.​frenchSingleScoreDetails.​traceabilityDisplayCoefficientnumberrequired
results.​frenchSingleScoreDetails.​brandSettingsobjectrequired
results.​frenchSingleScoreDetails.​brandSettings.​companySizeobject(WordingTranslations)required
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​enstring
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​frstring
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​esstring
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​itstring
results.​frenchSingleScoreDetails.​brandSettings.​repairServicebooleanrequired
results.​frenchSingleScoreDetails.​brandSettings.​traceabilityDisplaybooleanrequired
results.​frenchSingleScoreDetails.​brandSettings.​maxReferencesNumbernumberrequired
results.​frenchSingleScoreDetails.​brandSettings.​productPricenumberrequired
results.​frenchSingleScoreDetails.​brandSettings.​createdAtstring(date-time)required
results.​ecotoxicityFreshWaternumberrequired
linksArray of objects(LinkV2FormatPublicOutputMin)required

A list of minimal information on links related to this study

links[].​linkstringrequired

URL pointing to an HTTP ressource

links[].​typestringrequired

Type of the link

showcaseTextsobjectrequired
showcaseTexts.​materialTextDescriptionobjectrequired

Description for material

showcaseTexts.​recyclabilityTextDescriptionobjectrequired

Description for recyclability

showcaseTexts.​descriptionACVobjectrequired

Description for the Lifecycle Analysis

showcaseTexts.​descriptionACVSpecificobjectrequired

Specific description for the Lifecycle Analysis

packagingArray of objects(PackagingV2FormatOutput)required

A list of packagings linked to this study

packaging[].​idstringrequired

Unique identifier of this packaging

packaging[].​packagingRefstringrequired

Ref of the Packaging

packaging[].​typestringrequired

Type of packaging

packaging[].​channelstringrequired

Distribution channel where the packaging is used

packaging[].​compostabilitystringrequired

Compostability of the packaging

packaging[].​ecoModulationstringrequired
packaging[].​hazardousSubstancesobjectrequired

Hazardous substances that are part of the packaging

packaging[].​percentageRecyclednumberrequired

Percentage of the packaging that is made from recycled matter

packaging[].​possibilityReUsestringrequired

Possibility of re-use of the packaging

Enum"N/A""NO - 0""YES - REFILLABLE""YES - REUSABLE"
packaging[].​recyclabilitystringrequired

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"
packaging[].​typeTranslationsobjectrequired
Example: {"en":"Box","fr":"Boîte","es":"Caja"}
packaging[].​typeTranslations.​enstring
Example: "Box"
packaging[].​typeTranslations.​frstring
Example: "Boîte"
packaging[].​typeTranslations.​esstring
Example: "Caja"
packaging[].​typeTranslations.​itstring
packaging[].​agecClaimsobjectrequired
packaging[].​agecClaims.​ecoModulationobjectrequired

AGEC Claim : Eco modulation of the packaging

packaging[].​agecClaims.​compostabilityobjectrequired

AGEC Claim : Compostability of the packaging

packaging[].​agecClaims.​recycledMaterialsobjectrequired

AGEC Claim : Recycled matter presence in the packaging

packaging[].​agecClaims.​recyclabilityobjectrequired

AGEC Claim : Recyclability of the packaging

packaging[].​agecClaims.​possibilityReUseobjectrequired

AGEC Claim : Possibility of re-use of the packaging

agecClaimsobjectrequired
agecClaims.​ecoModulationobjectrequired

AGEC Claim : Eco Modulation of the product

agecClaims.​microfibersobjectrequired

AGEC Claim : Microfibers presence in the product

agecClaims.​recycledMaterialsobjectrequired

AGEC Claim : Recycled matter presence in the product

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": {}
  }
}

Get study details by id

Request

Security
bearer
Path
idstringrequired

The study's id

Query
langArray of strings

Languages for AGEC Claims translations

Items Enum"fr""en""es""it"
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>'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of this study

statestringrequired

Last known state of study's progress

Enum"PLANNED""REVIEWED""ARCHIVED""PUBLISHED""COMPLETED""IN_PROGRESS""CANCELLED"
brandCollectionNamestringrequired

Name of the brand collection the study belongs to

categorystringrequired

Category of the study

productRefstringrequired

Product reference

colorCodestringrequired

Color code of the study

projectTypestringrequired

The type of project the study belongs to

purchaseOrderstringrequired

Purchase order the study is linked to

showcaseLinksstringrequired

A list of links to showcases separated by semi-colons

weightnumberrequired

Weight in grams of the product

ecoModulationstringrequired

Eco contribution information

picturestringrequired

A link to the study's picture

productobjectrequired
product.​idstringrequired

Unique identifier of this product

product.​refstringrequired

Reference code of the product

product.​namestringrequired

Name of the product

product.​publicNamestringrequired

Public name of the product usually displayed on public ressources

product.​certificationsArray of objects(CertificationV2FormatOutputMin)required

List of certifications tied to this product

product.​certifications[].​namestringrequired
product.​certifications[].​statusstringrequired
Enum"NOT_VERIFIED""CAUTION""VALIDATED""EXPIRED"
product.​certifications[].​isVisiblebooleanrequired
componentsArray of objects(ComponentV2FormatOutput)required

A list of components linked to this study

components[].​refstringrequired

Ref of the component

components[].​supplierCodestringrequired

Supplier reference code linked to the component

components[].​lotReferencesArray of stringsrequired

A list of batch reference

components[].​typestringrequired

Type of component

components[].​generalCompositionstringrequired

General composition of the component separated by semi-colons

components[].​namestringrequired

Name of the component

components[].​categorystringrequired

Category of the component

components[].​compositionArray of objects(MaterialFormatShowcase)required

A list of material used to make the component

components[].​composition[].​idstringrequired

Unique identifier of the material

components[].​composition[].​percentagenumberrequired

Percentage of this material the parent component is made of

components[].​composition[].​raw_materialstringrequired

Name of its raw material

components[].​composition[].​raw_material_smcpstringrequired

Specific raw material name for SMCP

components[].​composition[].​materialTranslationsobjectrequired
components[].​composition[].​materialTranslations.​enstring
components[].​composition[].​materialTranslations.​frstring
components[].​composition[].​materialTranslations.​esstring
components[].​composition[].​materialTranslations.​itstring
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)

components[].​composition[].​traceability_steps[].​idstringrequired

Unique identifier of this traceability step

components[].​composition[].​traceability_steps[].​namestringrequired

Name of the traceability step

components[].​composition[].​traceability_steps[].​positionstringrequired

Three sets of numbers going from 001 to 999, giving the absolute position of the traceability step in the tree

components[].​composition[].​traceability_steps[].​iconstringrequired

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

components[].​composition[].​traceability_steps[].​transports[].​typestringrequired

Type of this transport

components[].​composition[].​traceability_steps[].​transports[].​distancenumberrequired

Distance travelled with this transport

components[].​composition[].​traceability_steps[].​transportationTypestring

Default transportation type assigned

components[].​composition[].​traceability_steps[].​supplierobjectrequired
components[].​composition[].​traceability_steps[].​supplier.​refstring

Reference of this supplier

components[].​composition[].​traceability_steps[].​supplier.​citystringrequired

City of this supplier

components[].​composition[].​traceability_steps[].​supplier.​countrystringrequired

Country of this supplier

components[].​composition[].​traceability_steps[].​supplier.​regionstringrequired

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

components[].​composition[].​traceability_steps[].​supplier.​isKnownbooleanrequired

Indicates if the supplier is known by the system

components[].​composition[].​traceability_steps[].​supplier.​namestring

The name of this supplier

components[].​composition[].​traceability_steps[].​supplier.​idstring

The unique identifier of this supplier

components[].​composition[].​traceability_steps[].​kmToNextnumberrequired

Number of kilometers separating this traceability step and the next one

components[].​weightnumberrequired

Weight of the component

components[].​categoryTranslationsobjectrequired
Example: {"en":"Paddings","fr":"Rembourrage","es":"Acolchado"}
components[].​categoryTranslations.​enstring
Example: "Paddings"
components[].​categoryTranslations.​frstring
Example: "Rembourrage"
components[].​categoryTranslations.​esstring
Example: "Acolchado"
components[].​categoryTranslations.​itstring
resultsobjectrequired
results.​resourceUseMineralsMetalsnumberrequired

EF impact category that addresses the use of non-renewable abiotic natural resources (minerals and metals) (in kg Sb eq)

results.​resourceUseFossilsnumberrequired

EF impact category that addresses the use of non-renewable fossil natural resources (e.g. natural gas, coal, oil) (in MJ)

results.​acidificationnumberrequired

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)

results.​humanToxicityCancernumberrequired

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)

results.​humanToxicityNonCancernumberrequired

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)

results.​eutrophicationFreshWaternumberrequired

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)

results.​eutrophicationMarinenumberrequired

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)

results.​eutrophicationTerrestrialnumberrequired

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)

results.​climateChangenumberrequired

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)

results.​climateChangeBiogenicnumberrequired
results.​climateChangeFossilnumberrequired
results.​climateChangeLandUsenumberrequired
results.​ionisingRadiationnumberrequired

EF impact category that accounts for the adverse health effects on human health caused by radioactive releases (in kBq U235 eq)

results.​landusenumberrequired

Use (occupation) and conversion (transformation) of land area by activities such as agriculture, forestry, roads, housing, mining, etc. (in points)

results.​ozoneDepletionnumberrequired

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)

results.​particulateMatternumberrequired

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)

results.​photochemicalOzoneFormationnumberrequired

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)

results.​waterUsenumberrequired

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)

results.​recycledMaterialsPercentagenumberrequired
results.​microplasticPercentagenumberrequired
results.​climateChangeEquivalenceobjectrequired
results.​eutrophicationFreshWaterEquivalenceobjectrequired
results.​resourceUseFossilsEquivalenceobjectrequired
results.​gradesobjectrequired
results.​grades.​recyclabilitynumberrequired

Ability to effectively recycle waste from identical or similar products

results.​grades.​traceabilitynumberrequired

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

results.​grades.​compliancenumberrequired

Average of the social performance of the various stakeholders in the value chain associated with it

results.​frenchSingleScorenumberrequired
results.​frenchSingleScorePerUnitWeightnumberrequired

French Single Score per unit weight

results.​frenchSingleScoreDetailsobjectrequired
results.​frenchSingleScoreDetails.​brandScorenumberrequired

Score of the brand

results.​frenchSingleScoreDetails.​productScorenumberrequired

Score of the product

results.​frenchSingleScoreDetails.​frenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​malusBonusServiceDurationnumberrequired
results.​frenchSingleScoreDetails.​referenceServiceDurationnumberrequired
results.​frenchSingleScoreDetails.​adjustedServiceDurationnumberrequired
results.​frenchSingleScoreDetails.​lcaFrenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​ooeuExportFrenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​microfibersFrenchSingleScorenumberrequired
results.​frenchSingleScoreDetails.​productRangeCoefficientnumberrequired
results.​frenchSingleScoreDetails.​repairPromotionCoefficientnumberrequired
results.​frenchSingleScoreDetails.​traceabilityDisplayCoefficientnumberrequired
results.​frenchSingleScoreDetails.​brandSettingsobjectrequired
results.​frenchSingleScoreDetails.​brandSettings.​companySizeobject(WordingTranslations)required
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​enstring
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​frstring
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​esstring
results.​frenchSingleScoreDetails.​brandSettings.​companySize.​itstring
results.​frenchSingleScoreDetails.​brandSettings.​repairServicebooleanrequired
results.​frenchSingleScoreDetails.​brandSettings.​traceabilityDisplaybooleanrequired
results.​frenchSingleScoreDetails.​brandSettings.​maxReferencesNumbernumberrequired
results.​frenchSingleScoreDetails.​brandSettings.​productPricenumberrequired
results.​frenchSingleScoreDetails.​brandSettings.​createdAtstring(date-time)required
results.​ecotoxicityFreshWaternumberrequired
linksArray of objects(LinkV2FormatPublicOutputMin)required

A list of minimal information on links related to this study

links[].​linkstringrequired

URL pointing to an HTTP ressource

links[].​typestringrequired

Type of the link

showcaseTextsobjectrequired
showcaseTexts.​materialTextDescriptionobjectrequired

Description for material

showcaseTexts.​recyclabilityTextDescriptionobjectrequired

Description for recyclability

showcaseTexts.​descriptionACVobjectrequired

Description for the Lifecycle Analysis

showcaseTexts.​descriptionACVSpecificobjectrequired

Specific description for the Lifecycle Analysis

packagingArray of objects(PackagingV2FormatOutput)required

A list of packagings linked to this study

packaging[].​idstringrequired

Unique identifier of this packaging

packaging[].​packagingRefstringrequired

Ref of the Packaging

packaging[].​typestringrequired

Type of packaging

packaging[].​channelstringrequired

Distribution channel where the packaging is used

packaging[].​compostabilitystringrequired

Compostability of the packaging

packaging[].​ecoModulationstringrequired
packaging[].​hazardousSubstancesobjectrequired

Hazardous substances that are part of the packaging

packaging[].​percentageRecyclednumberrequired

Percentage of the packaging that is made from recycled matter

packaging[].​possibilityReUsestringrequired

Possibility of re-use of the packaging

Enum"N/A""NO - 0""YES - REFILLABLE""YES - REUSABLE"
packaging[].​recyclabilitystringrequired

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"
packaging[].​typeTranslationsobjectrequired
Example: {"en":"Box","fr":"Boîte","es":"Caja"}
packaging[].​typeTranslations.​enstring
Example: "Box"
packaging[].​typeTranslations.​frstring
Example: "Boîte"
packaging[].​typeTranslations.​esstring
Example: "Caja"
packaging[].​typeTranslations.​itstring
packaging[].​agecClaimsobjectrequired
packaging[].​agecClaims.​ecoModulationobjectrequired

AGEC Claim : Eco modulation of the packaging

packaging[].​agecClaims.​compostabilityobjectrequired

AGEC Claim : Compostability of the packaging

packaging[].​agecClaims.​recycledMaterialsobjectrequired

AGEC Claim : Recycled matter presence in the packaging

packaging[].​agecClaims.​recyclabilityobjectrequired

AGEC Claim : Recyclability of the packaging

packaging[].​agecClaims.​possibilityReUseobjectrequired

AGEC Claim : Possibility of re-use of the packaging

agecClaimsobjectrequired
agecClaims.​ecoModulationobjectrequired

AGEC Claim : Eco Modulation of the product

agecClaims.​microfibersobjectrequired

AGEC Claim : Microfibers presence in the product

agecClaims.​recycledMaterialsobjectrequired

AGEC Claim : Recycled matter presence in the product

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": {}
  }
}

Get study showcase by id

Request

Security
bearer
Path
idstringrequired

The study's id

Query
langArray of strings

Languages for AGEC Claims translations

Default ["en"]
Items Enum"fr""en""es""it"
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>'

Responses

Bodyapplication/json
namestringrequired
publicNamestringrequired
typestringrequired
colorstringrequired
picturestringrequired
skustringrequired
componentsArray of objects(ComponentFormatShowcase)required
Array [
components[][].​namestringrequired
components[][].​categorystringrequired
components[][].​category_smcpstring

Specific category name for SMCP

components[][].​compositionArray of objects(MaterialFormatShowcase)required
components[][].​composition[].​idstringrequired

Unique identifier of the material

components[][].​composition[].​percentagenumberrequired

Percentage of this material the parent component is made of

components[][].​composition[].​raw_materialstringrequired

Name of its raw material

components[][].​composition[].​raw_material_smcpstringrequired

Specific raw material name for SMCP

components[][].​composition[].​materialTranslationsobjectrequired
components[][].​composition[].​materialTranslations.​enstring
components[][].​composition[].​materialTranslations.​frstring
components[][].​composition[].​materialTranslations.​esstring
components[][].​composition[].​materialTranslations.​itstring
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)

components[][].​composition[].​traceability_steps[].​idstringrequired

Unique identifier of this traceability step

components[][].​composition[].​traceability_steps[].​namestringrequired

Name of the traceability step

components[][].​composition[].​traceability_steps[].​positionstringrequired

Three sets of numbers going from 001 to 999, giving the absolute position of the traceability step in the tree

components[][].​composition[].​traceability_steps[].​iconstringrequired

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

components[][].​composition[].​traceability_steps[].​transportationTypestring

Default transportation type assigned

components[][].​composition[].​traceability_steps[].​supplierobjectrequired
components[][].​composition[].​traceability_steps[].​kmToNextnumberrequired

Number of kilometers separating this traceability step and the next one

]
gradesobject(ProductGradesFormatShowcase)required
grades.​recyclabilitynumberrequired
grades.​traceabilitynumberrequired
productCertificationsArray of objects(CertificationFormatShowcase)required
productCertifications[].​refstringrequired

Reference code of this certification

productCertifications[].​namestringrequired

Name of the certification

productCertifications[].​statusstringrequired

Current status for this certification

Enum"NOT_VERIFIED""CAUTION""VALIDATED""EXPIRED"
productCertifications[].​isVisiblebooleanrequired

Indicates if the document can be displayed or not

impactsobject(ProductImpactFormatPublicShowcase)required
impacts.​descriptionACVSpecificobjectrequired
impacts.​descriptionACVobjectrequired
impacts.​materialTextDescriptionobjectrequired
impacts.​recyclabilityTextDescriptionobjectrequired
impacts.​climateChangenumberrequired
impacts.​climateChangeEquivalenceobjectrequired
impacts.​eutrophicationFreshWaternumberrequired
impacts.​eutrophicationFreshWaterEquivalenceobjectrequired
impacts.​resourceUseFossilsnumberrequired
impacts.​resourceUseFossilsEquivalenceobjectrequired
impacts.​publicProductNamesobjectrequired
impacts.​ecoContributionstringrequired
impacts.​recycledMaterialsPercentagenumberrequired
impacts.​microplasticPercentagenumberrequired
impacts.​hazardousSubstancesTextDescriptionobjectrequired
impacts.​frenchSingleScorenumberrequired
impacts.​frenchSingleScorePerUnitWeightnumberrequired
impacts.​frenchSingleScoreDetailsobject(FrenchSingleScoreDetailsPublicOutput)required
impacts.​frenchSingleScoreDetails.​brandScorenumberrequired

Score of the brand

impacts.​frenchSingleScoreDetails.​productScorenumberrequired

Score of the product

impacts.​frenchSingleScoreDetails.​frenchSingleScorenumberrequired
impacts.​frenchSingleScoreDetails.​malusBonusServiceDurationnumberrequired
impacts.​frenchSingleScoreDetails.​referenceServiceDurationnumberrequired
impacts.​frenchSingleScoreDetails.​adjustedServiceDurationnumberrequired
impacts.​frenchSingleScoreDetails.​lcaFrenchSingleScorenumberrequired
impacts.​frenchSingleScoreDetails.​ooeuExportFrenchSingleScorenumberrequired
impacts.​frenchSingleScoreDetails.​microfibersFrenchSingleScorenumberrequired
impacts.​frenchSingleScoreDetails.​productRangeCoefficientnumberrequired
impacts.​frenchSingleScoreDetails.​repairPromotionCoefficientnumberrequired
impacts.​frenchSingleScoreDetails.​traceabilityDisplayCoefficientnumberrequired
impacts.​frenchSingleScoreDetails.​brandSettingsobjectrequired
impacts.​frenchSingleScoreDetails.​brandSettings.​companySizeobject(WordingTranslations)required
impacts.​frenchSingleScoreDetails.​brandSettings.​companySize.​enstring
impacts.​frenchSingleScoreDetails.​brandSettings.​companySize.​frstring
impacts.​frenchSingleScoreDetails.​brandSettings.​companySize.​esstring
impacts.​frenchSingleScoreDetails.​brandSettings.​companySize.​itstring
impacts.​frenchSingleScoreDetails.​brandSettings.​repairServicebooleanrequired
impacts.​frenchSingleScoreDetails.​brandSettings.​traceabilityDisplaybooleanrequired
impacts.​frenchSingleScoreDetails.​brandSettings.​maxReferencesNumbernumberrequired
impacts.​frenchSingleScoreDetails.​brandSettings.​productPricenumberrequired
impacts.​frenchSingleScoreDetails.​brandSettings.​createdAtstring(date-time)required
hasDurabilitybooleanrequired
studyTypestringrequired
packagingArray of objects(PackagingFormatShowcase)required
packaging[].​idstringrequired
packaging[].​namestringrequired
packaging[].​refstringrequired
packaging[].​typestringrequired
packaging[].​channelstringrequired
packaging[].​percentageRecyclednumberrequired
packaging[].​ecoContributionstringrequired
packaging[].​compostabilitystringrequired
packaging[].​recyclabilitystringrequired
packaging[].​possibilityReUsestringrequired
packaging[].​hazardousSubstancesobjectrequired
agecClaimsobjectrequired
agecClaims.​ecoModulationobjectrequired

AGEC Claim : Eco Modulation of the product

agecClaims.​microfibersobjectrequired

AGEC Claim : Microfibers presence in the product

agecClaims.​recycledMaterialsobjectrequired

AGEC Claim : Recycled matter presence in the product

statestringrequired
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"
}

Get the list of published studies linked to caller's account id

Request

Security
bearer
Query
statestring
collectionRefstring
productRefstringrequired
colorCodestring
dateStartstring
dateEndstring
limitnumber

The number of items to return.

Default 20
offsetnumber

The number of items to skip before starting to collect the result.

Default 0
sortByArray of strings

Sort the results by the specified field(s).

sortDescArray of booleans

Sort the results in descending order. (true for descending, false for ascending)

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>'

Responses

Get suppliers

Request

Security
bearer
Query
limitnumber

The number of items to return.

Default 20
offsetnumber

The number of items to skip before starting to collect the result.

Default 0
sortByArray of strings

Sort the results by the specified field(s).

sortDescArray of booleans

Sort the results in descending order. (true for descending, false for ascending)

searchstring
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>'

Responses

Bodyapplication/json
offsetnumber

The number of items skiped before starting to collect the result.

Default 0
limitnumber

The number of items to return.

Default 20
totalnumber

The total number of items.

dataArray of objects(SuppliersFormatOutputAll)

The list of items.

Response
application/json
{
  "offset": 0,
  "limit": 20,
  "total": 0,
  "data": [
    { … }
  ]
}

Get supplier details

Request

Security
bearer
Path
idstringrequired

Fairly Made's Supplier Id or your supplierRef

curl -i -X GET \
  'https://doc.api.fairlymade.com/_mock/swagger-public-v2/v2/suppliers/{id}' \
  -H 'Authorization: Bearer <YOUR_Bearer _HERE>'

Responses

Bodyapplication/json
idstringrequired
supplierRefArray of stringsrequired
namestringrequired
typestringrequired
createdAtstring(date-time)required
addressobject(AddressPublicV2Dto)required
address.​labelstring

The label of the address

Example: "Home"
address.​streetstring

The street of the address

Example: "1st street"
address.​additionalStreetstring

The additional street of the address

Example: "2nd street"
address.​citystring

The city of the address

Example: "Paris"
address.​administrativeAreastring

The administrative area of the address

Example: "Ile-de-France"
address.​postalCodestring

The postal code of the address

Example: "75000"
address.​countrystringrequired

ISO 3166-1 alpha-2 format (e.g : China = CN, France = FR)

Example: "CN"
address.​regionstring

Continent or an area of the world

Example: "Asia"
factory_performancesobject(SupplierFactoryPerformancesDto)required
factory_performances.​productionCapacitystring
factory_performances.​lossesnumber
factory_performances.​greenElectricityEquipmentPercentagenumber
factory_performances.​electricityConsumptionPerMonthnumber
factory_performances.​inHouseEffluentPercentagenumber
factory_performances.​transportationsArray of stringsrequired
factory_performances.​hasProgramImpactParticipationbooleanrequired
factory_performances.​heatTypestringrequired
factory_performances.​hasGreenElectricityEquipmentbooleanrequired
factory_performances.​greenElectricityEquipmentKindstringrequired
factory_performances.​hasInHouseEffluentTreatmentSystembooleanrequired
factory_performances.​inHouseEffluentKindstringrequired
factory_performances.​hasEnergyEfficientInvestmentbooleanrequired
factory_performances.​energyEfficientKindstringrequired
factory_performances.​hasWashedAfterManufacturingbooleanrequired
factory_performances.​washedAfterManufacturingLaundrystringrequired
detailsobject(AccountDetails)required
details.​nb_employeesnumberrequired
details.​websitestring
details.​contactEmailstring
contactsArray of objects(SupplierContactFormatMin)required
contacts[].​idstringrequired
contacts[].​createdAtstring(date-time)required
contacts[].​personobject(PersonOutputMin)required
contacts[].​person.​emailstring
categorystringrequired
certificationsArray of objects(CertificationFormatOutput)required
certifications[].​idstringrequired
certifications[].​typestringrequired
certifications[].​date_startstring(date-time)required
certifications[].​date_endstring(date-time)required
certifications[].​statusstringrequired
Enum"NOT_VERIFIED""CAUTION""VALIDATED""EXPIRED"
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": [
    { … }
  ]
}