Skip to content

Call by id

Request

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

Updates a purchased item that belongs to your organisation (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).

The item type (product, component, or material) is fixed at creation and cannot be changed.

The buyer and seller are also fixed at creation and cannot be changed on update — buyerKind, buyerId, buyerUniqueIdentifier, sellerId and sellerUniqueIdentifier are not part of the update body (sending any of them returns 400).

When present, transports, certifications, and purchasedQuantity replace the previous values in full.

⚠️ Purchased items: a resource belonging to another client returns 404 (PurchasedItem_NotFound), not 403 — unlike other inventory entities on Call by id.

Path
idstring, (uuid)required

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

Bodyapplication/jsonrequired
itemIdstring, (uuid)

System UUID of the purchased entity. Provide exactly one of itemId or itemUniqueIdentifier.

itemUniqueIdentifierstring

Client uniqueIdentifier of the purchased entity. Mutually exclusive with itemId.

purchaseOrderstring or null
purchaseOrderDatestring or null, (date)
transportsArray of objects(Transport)
purchasedQuantityobject or null(Quantity)
certificationsArray of objects(Certification)
curl -i -X PATCH \
  'https://doc.api.fairlymade.com/_mock/swagger-fairlymadeapi-v3/purchased-items/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
    "itemUniqueIdentifier": "string",
    "purchaseOrder": "string",
    "purchaseOrderDate": "2019-08-24",
    "transports": [
      {
        "name": "BARGE",
        "usagePercentage": 0
      }
    ],
    "purchasedQuantity": {
      "value": 0,
      "unit": "GRAMS"
    },
    "certifications": [
      {
        "certificationName": "string"
      }
    ]
  }'

Responses

Updated purchased item; response body is the full item record.

Bodyapplication/json
property name*anyadditional property
Response
{}