Supplier Part

The supplier part resource.

Basehttps://rest.carbon.ms/supplierPart

GET/supplierPart

List supplier parts

Retrieve a paginated list of supplier parts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/supplierPart

curl --request GET \
  --url 'https://rest.carbon.ms/supplierPart?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "itemId": "xyz789",
    "supplierId": "xyz789",
    "conversionFactor": 0,
    "active": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/supplierPart

Retrieve a supplier part

Fetch a single supplier part by filtering on `id`.

Query parameters

idstring

Match on the supplier part's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplierPart

curl --request GET \
  --url 'https://rest.carbon.ms/supplierPart?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "supplierId": "xyz789",
  "conversionFactor": 0,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/supplierPart

Create a supplier part

Create a new supplier part.

Body parameters

itemIdstringrequired

References item.id

supplierIdstringrequired

References supplier.id

supplierPartIdstring

supplierUnitOfMeasureCodestring

minimumOrderQuantitynumber

conversionFactornumberrequired

activebooleanrequired

customFieldsobject

unitPricenumber

tagsarray

POSThttps://rest.carbon.ms/supplierPart

curl --request POST \
  --url https://rest.carbon.ms/supplierPart \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","supplierId":"xyz789","conversionFactor":0,"active":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "supplierId": "xyz789",
  "conversionFactor": 0,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/supplierPart

Update a supplier part

Update an existing supplier part, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

supplierIdstringrequired

References supplier.id

supplierPartIdstring

supplierUnitOfMeasureCodestring

minimumOrderQuantitynumber

conversionFactornumberrequired

activebooleanrequired

customFieldsobject

unitPricenumber

tagsarray

PATCHhttps://rest.carbon.ms/supplierPart

curl --request PATCH \
  --url 'https://rest.carbon.ms/supplierPart?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "supplierId": "xyz789",
  "conversionFactor": 0,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/supplierPart

Delete a supplier part

Delete a supplier part, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the supplier part to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/supplierPart

curl --request DELETE \
  --url 'https://rest.carbon.ms/supplierPart?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content