Skip to content

Call by id

Request

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

Updates a manufactured component (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).

When you send compositions, the array replaces the previous list and must contain at least one line; percentages must sum to 100%.

If the component exists but belongs to another client → 403 (ManufacturedComponentOwnershipViolation).

Path
idstring, (uuid)required

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

Bodyapplication/jsonrequired
referencestring
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.

categorystring

Component category; same allowed values as POST /manufactured-components.

compositionsArray of objects, non-empty(Composition)
stepsArray of objects(ComponentStep)
purchasedItemsArray of objects(ManufacturedComponentPatchPurchasedItem)
usedComponentsArray of objects(UsedComponent)
usedMaterialsArray of objects(ManufacturedComponentPatchUsedMaterial)
curl -i -X PATCH \
  'https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/manufactured-components/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "reference": "string",
    "ownerKind": "SUPPLIER",
    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
    "ownerUniqueIdentifier": "string",
    "address": {
      "country": "AD",
      "city": "string",
      "postalCode": "string",
      "street": "string"
    },
    "category": "string",
    "compositions": [
      {
        "compositionRawMaterial": "ABACÁ",
        "compositionRawAttribute": "BIO_BASED",
        "compositionPercentage": 0,
        "compositionOrigin": "AD",
        "compositionCertifications": [
          "ABELUSI WOOL"
        ]
      }
    ],
    "steps": [
      {
        "process": "ACID_WASHING"
      }
    ],
    "purchasedItems": [
      {
        "purchasedItemId": "c71367fd-41b4-4f55-a878-880751ae6d3a",
        "purchasedItemUniqueIdentifier": "string",
        "usagePercentage": 0,
        "usageCategory": "string"
      }
    ],
    "usedComponents": [
      {
        "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
        "componentUniqueIdentifier": "string",
        "usageCategory": "BACKINGS/COUNTERS",
        "usagePercentage": 0
      }
    ],
    "usedMaterials": [
      {
        "materialId": "30cdab3c-3e2b-44f4-8415-c6dd88ed4261",
        "materialUniqueIdentifier": "string",
        "usagePercentage": 0
      }
    ]
  }'

Responses

Updated component; response body is the full component record.

Bodyapplication/json
property name*anyadditional property
Response
{}