Skip to content

Fairly Made API (3.0.0)

The Fairly Made API describes endpoints for creating and retrieving supply‑chain entities such as suppliers, materials, components, products and purchased items.

Download OpenAPI description
swagger-FairlyMadeAPI-v3.json
swagger-FairlyMadeAPI-v3.yaml
Languages
Servers
Mock server
https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3
https://api.fairlymade.com

Create supplier

Request

Create a new supplier record with site information and optional certifications.

Bodyapplication/jsonrequired
unique_identifierstring[ 15 .. 255 ] charactersrequired

This identifier will make each supplier site unique in our systems.

parent_company_namestring

Supplier parent company name.

site_namestring

Name of the supplier site.

site_emailstring(email)

Email address of the supplier site.

site_addressobject(Address)required

Postal address of an entity.

site_address.​countrystring= 2 characters

Two‑letter ISO country code. Taxonomy – COUNTRY

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
site_address.​citystring
site_address.​postalCodestring
site_address.​streetstring
site_certificationsArray of objects(SupplierCertification)

Optional list of certifications for this supplier site.

curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/suppliers \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifier": "FM-SUPPLIER-SITE-0001",
    "name": "Supplier A",
    "site_address": {
      "country": "FR"
    }
  }'

Responses

Supplier created successfully

Bodyapplication/json
supplier_idstring(uuid)

System-generated identifier of the created supplier.

Response
application/json
{
  "supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c"
}

Create material

Request

Create a raw material and optionally define processing steps; you must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

Bodyapplication/jsonrequired
unique_identifierstring[ 15 .. 255 ] charactersrequired

This identifier will make each material unique in our systems.

owner_kindstring
Value"SUPPLIER"
owner_idstring(uuid)

Must be the id of your material supplier. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

addressobject

If you do not know the supplier of the item, you have the option to only fill an address. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

raw_materialstringrequired
Enum"ABACÁ""ACETAL""ACETATE""ACRYLIC""ACRYLIC RESIN""ACRYLONITRILE BUTADIENE RUBBER""ACRYLONITRILE BUTADIENE STYRENE""ALGINATE""ALLIGATOR LEATHER""ALLIGATOR MISSISSIPPIENSIS LEATHER"
stepsArray of objects(MaterialStep)
purchased_itemsArray of objects(MaterialPurchasedItem)

Purchased material inputs to produce this material. Each item represents a purchased material and its contribution percentage. Only applicable when the entity is linked with an owner (owner_kind, owner_id); not used when providing a processing step address. Sum of purchased items and used items usage_percentage must equal 100.

used_materialsArray of objects(UsedMaterial)

Materials used as inputs for this material along with their usage percentage.

curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/materials \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifier": "FM-MATERIAL-COTTON-0001",
    "owner_kind": "SUPPLIER",
    "owner_id": "a5765369-b42c-4e6f-849b-0c3873e8deb5",
    "raw_material": "COTTON"
  }'

Responses

Material created

Bodyapplication/json
material_idstring(uuid)

Identifier of the created material.

Response
application/json
{
  "material_id": "fba2a54e-bc4a-4e2a-8ad4-84dcfe66dea1"
}

Create component

Request

Create a component with composition, optional ownership/address, optional category_family, steps, purchased items, used components and materials. Returns component ID. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

Bodyapplication/jsonrequired
unique_identifierstring[ 15 .. 255 ] charactersrequired

This identifier will make each component unique in our systems.

owner_kindstring
Value"SUPPLIER"
owner_idstring(uuid)

Must be the id of your component supplier. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

addressobject

If you do not know the supplier of the item, you have the option to only fill an address. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

category_familystring

Describes the intrinsic material or part category of a component.

Enum"ANIMAL""BACKINGS/COUNTERS""BEADS""BELT LOOPS""BIAS STRIPS""BRA CLIPS""BUCKLES""BUTTINETTES""BUTTONS""CHAIN"
compositionsArray of objects(Composition)non-emptyrequired

Composition details; the sum of percentages must equal 100% and components must be unique. When a raw material has multiple origins, you must create multiple entries in the array (one per origin).

compositions[].​composition_raw_materialstringrequired

Raw material taxonomy.

Enum"ABACÁ""ACETAL""ACETATE""ACRYLIC""ACRYLIC RESIN""ACRYLONITRILE BUTADIENE RUBBER""ACRYLONITRILE BUTADIENE STYRENE""ALGINATE""ALLIGATOR LEATHER""ALLIGATOR MISSISSIPPIENSIS LEATHER"
compositions[].​composition_percentagenumber[ 0 .. 100 ]required

Percentage of this raw material (total composition must sum to 100%).

compositions[].​composition_originstring= 2 characters

Two‑letter ISO country code. Taxonomy – COUNTRY

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
stepsArray of objects(ComponentStep)
purchased_itemsArray of objects(ProductPurchasedItem)

Purchased items used to produce this component (can be purchased component or purchased material). If the purchased item is a component, usage_category is mandatory. Only applicable when the entity is linked with an owner (owner_kind, owner_id); not used when providing a processing step address. Sum of purchased items and used items usage_percentage must equal 100.

used_componentsArray of objects(UsedComponent)
used_materialsArray of objects
curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/components \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifier": "FM-COMPONENT-FABRIC-0001",
    "owner_kind": "SUPPLIER",
    "owner_id": "5d1bb854-6193-465c-a3b1-69f9e34d8d91",
    "compositions": [
      {
        "composition_raw_material": "COTTON",
        "composition_percentage": 100
      }
    ]
  }'

Responses

Component created. Return Component ID.

Bodyapplication/json
component_idstring(uuid)

Identifier of the created component.

Response
application/json
{
  "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b"
}

Create manufactured product

Request

Products aggregate materials, components and packaging with weight, quantity and usage details. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

Bodyapplication/jsonrequired
unique_identifierstringrequired

This identifier will make each product unique in our systems.

owner_kindstring
Value"SUPPLIER"
owner_idstring(uuid)

Must be the id of your manufacturing supplier. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

addressobject

If you do not know the supplier of the item, you have the option to only fill an address. You must include either the owner (owner_kind, owner_id) or the processing step address, but not both.

categorystringrequired

Product category taxonomy. Values.

Enum"ACCESSORIES""APRONS""BACKPACKS""BATHROBES""BATH_MATS""BATH_TOWELS""BEACH_BAGS""BEACH_TOWELS""BEANIES""BELTS"
stepsArray of objects(ProductStep)
purchased_itemsArray of objects(ProductPurchasedItem)

Purchased items used in this product. Only applicable when the entity is linked with an owner (owner_kind, owner_id); not used when providing a processing step address. Sum of purchased items and used items usage_percentage must equal 100.

used_productsArray of objects(UsedProduct)
used_componentsArray of objects(UsedComponent)
curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/products \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifier": "FM-PRODUCT-SHIRT-0001",
    "owner_kind": "SUPPLIER",
    "owner_id": "f0b5fb65-f065-432e-9e96-c52692931626",
    "category": "SHIRTS"
  }'

Responses

Product created

Bodyapplication/json
product_idstring(uuid)

Identifier of the created product.

Response
application/json
{
  "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1"
}

Create purchased item

Request

Create a record representing an item purchased between buyers and sellers with transport and quantity details.

Bodyapplication/jsonrequired
unique_identifierstringrequired

This identifier will make each purchased item unique in our systems.

buyer_kindstringrequired
Enum"CUSTOMER""SUPPLIER"
buyer_idstring(uuid)required

The id of the buyer (customer or supplier) for this item.

seller_idstring(uuid)required

The id of the supplier that sold the item.

purchase_orderstring

Optional purchase order number.

transportsArray of objects(Transport)
purchased_quantityobject(Quantity)
certificationsArray of objects
item_idstring(uuid)required

Identifier of the purchased item

curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/purchased-items \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifier": "FM-PURCHASED-ITEM-MAT-0001",
    "buyer_kind": "CUSTOMER",
    "buyer_id": "f0b5fb65-f065-432e-9e96-c52692931626",
    "seller_id": "a5765369-b42c-4e6f-849b-0c3873e8deb5",
    "item_id": "364c5ece-7f42-418b-baa7-9a272dd044ef"
  }'

Responses

Purchased item created

Bodyapplication/json
purchased_item_idstring(uuid)

Identifier of the created purchased item.

Response
application/json
{
  "purchased_item_id": "b09f068d-086a-4d53-b786-0fe2e226539e"
}

Add customer product information

Request

Add additional generic information for a product or purchased item, such as packaging, naming, pricing and QR code association. This endpoint allows linking packaging and warehouse details to an existing product or purchased item.

Bodyapplication/jsonrequired
unique_identifierstring[ 1 .. 255 ] charactersrequired

This identifier will make each generic product information unique in our systems. We recommend concatenating ref, color_code, collection and the purchase_order from the related purchased item (create purchased item). Example ref_color_code_collection_purchase_order.

product_idstring(uuid)

Identifier of the manufactured product (create product) to which this information belongs.

purchased_item_idstring(uuid)

Identifier of the purchased item to which this information belongs.

refstring

Optional internal reference for the product information.

color_codestring

Unique color reference/name of the product.

Default "DEFAULT"
collectionstring
product_namestring
packaging_idstring(uuid)

Identifier of the associated packaging used for this product information.

gtins_or_eansstring

Global Trade Item Number (GTIN) or European Article Number (EAN). Should contain 13 digits.

market_segmentstring

Market segment taxonomy.

Enum"Menswear""Womenswear""Kidswear""Babywear""Lingerie"
product_pricenumber
eco_modulationstring

Eco-modulation taxonomy. Values.

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"
customBrandField1string

This field is linked to the Business Unit linked to this Product. We are expecting a string value. This field is specific to you and your organization.

customBrandField2string

This field is linked to the Division by Category linked to this Product. We are expecting a string value. This field is specific to you and your organization.

customBrandField3string

This field is linked to the Product Category of Group. We are expecting a string value. This field is specific to you and your organization.

Enum"RTW""Shoes""Bags""Small Leather Goods""Accessories""Home / Interior / Travel"
customBrandField4string

This field is linked to the Product Category of the Maison. We are expecting a string value. This field is specific to you and your organization.

produced_quantitynumber

Quantity produced for this specific product.

weightnumber

Weight of the product in grams.

qr_code_idstring(uuid)required

Identifier of the QR code associated with this generic product information.

warehouseobject(Warehouse)required

Information about the destination warehouse for generic product data. Either supplier_id or address.country must be provided.

warehouse.​supplier_idstring(uuid)

Identifier of the warehouse supplier.

warehouse.​addressobject(Address)

Postal address of an entity.

curl -i -X POST \
  https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/generic-product-infos \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifier": "FM-REF-001_DEFAULT_C01_PO-001",
    "ref": "REF-001",
    "color_code": "DEFAULT",
    "collection": "C01",
    "packaging_id": "c8568d90-0609-4ff6-b76f-5bf14051af43",
    "qr_code_id": "edf53f45-152b-4330-8925-90c2ffdd9c3b",
    "warehouse": {
      "address": {
        "country": "FR"
      }
    }
  }'

Responses

Generic product information added successfully

Bodyapplication/json
product_info_idstring(uuid)

Identifier of the created generic product information.

Response
application/json
{
  "product_info_id": "9053bb2b-5d9c-4fcf-86b3-cc9e75c1da0e"
}