Skip to content

Call by id

Request

Call by: id — the Fairly Made material id (UUID v4) from the 201 response.

Updates a manufactured material (registry scope from the access token).

Partial update: only include fields you want to change. Omitted fields stay as they are. uniqueIdentifier must not be included (sending it returns 400).

If you change the raw material, send both rawMaterialName and rawMaterialAttribute, or send neither. purchasedItems and usedMaterials are replaced in full when sent.

If the material exists but belongs to another client → 403 (ManufacturedMaterialOwnershipViolation).

Path
idstring, (uuid)required

Fairly Made resource id (UUID v4). Use the id from the 201 response of the corresponding POST endpoint.

Bodyapplication/jsonrequired
ownerKindstring or null
Value:"SUPPLIER"
ownerIdstring or null, (uuid)

System UUID of the supplier owner. Provide exactly one of ownerId or ownerUniqueIdentifier when setting an owner.

ownerUniqueIdentifierstring or null

Client uniqueIdentifier of the supplier owner. Requires ownerKind = SUPPLIER. Mutually exclusive with ownerId.

addressobject or null(Address)

Postal address of an entity.

rawMaterialNamestring(RawMaterialName)

Raw material name taxonomy (from official material–attribute pairs; each name must be combined with a valid attribute for that material). Use the Fairly Made Material Selector spreadsheet to see which attributes are allowed for each name (Step 1 = material, Step 2 = allowed attributes), then align with the enums here. Fairly Made Material Selector.

Enum:"ABACÁ""ACETAL""ACETATE""ACRYLIC""ACRYLIC RESIN""ACRYLONITRILE BUTADIENE RUBBER""ACRYLONITRILE BUTADIENE STYRENE""ALCANTARA""ALGINATE""ALLIGATOR LEATHER"
rawMaterialAttributestring(RawMaterialAttribute)

Raw material attribute taxonomy. Values are only valid in combination with a given raw material name; each material name accepts only the attributes defined in the official material–attribute pairs. To choose the correct attribute for a given material name, use the Fairly Made Material Selector (Google Sheets): Step 1 — select the material; Step 2 — lists the attributes you may use with that name. Then send the exact enum value from this schema. Fairly Made Material Selector.

Enum:"BIO_BASED""CHROME_FREE""CONVENTIONAL""FARMED""MIXED_TANNING""ORGANIC""RECYCLED""REGENERATIVE""VEGETABLE""WILD"
stepsArray of objects(MaterialStep)
purchasedItemsArray of objects(MaterialPurchasedItem)
usedMaterialsArray of objects(UsedMaterial)
curl -i -X PATCH \
  'https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/manufactured-materials/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "ownerKind": "SUPPLIER",
    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
    "ownerUniqueIdentifier": "string",
    "address": {
      "country": "AD",
      "city": "string",
      "postalCode": "string",
      "street": "string"
    },
    "rawMaterialName": "ABACÁ",
    "rawMaterialAttribute": "BIO_BASED",
    "steps": [
      {
        "process": "BREEDING"
      }
    ],
    "purchasedItems": [
      {
        "purchasedItemId": "c71367fd-41b4-4f55-a878-880751ae6d3a",
        "purchasedItemUniqueIdentifier": "string",
        "usagePercentage": 0
      }
    ],
    "usedMaterials": [
      {
        "materialId": "30cdab3c-3e2b-44f4-8415-c6dd88ed4261",
        "materialUniqueIdentifier": "string",
        "usagePercentage": 0
      }
    ]
  }'

Responses

Updated material; response body is the full material record.

Bodyapplication/json
property name*anyadditional property
Response
{}