Carbon

Item Supersession

The item supersession resource.

Basehttps://rest.carbon.ms/itemSupersession
GET/itemSupersession

List item supersessions

Retrieve a paginated list of item supersessions. 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/itemSupersession
curl --request GET \
  --url 'https://rest.carbon.ms/itemSupersession?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "itemId": "xyz789",
    "companyId": "xyz789",
    "supersessionMode": "string",
    "conversionFactor": 0,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "successorItemId": "xyz789",
    "discontinuationDate": "2026-01-01"
  }
]
GET/itemSupersession

Retrieve a item supersession

Fetch a single item supersession by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item supersession's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/itemSupersession
curl --request GET \
  --url 'https://rest.carbon.ms/itemSupersession?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "supersessionMode": "string",
  "conversionFactor": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "successorItemId": "xyz789",
  "discontinuationDate": "2026-01-01"
}
POST/itemSupersession

Create a item supersession

Create a new item supersession.

Body parameters

companyIdstringrequired

References company.id

supersessionModesupersessionModerequired
successorItemIdstring

References item.id

discontinuationDatedate
successorEffectivityDatedate
conversionFactornumberrequired
POSThttps://rest.carbon.ms/itemSupersession
curl --request POST \
  --url https://rest.carbon.ms/itemSupersession \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","supersessionMode":"string","conversionFactor":0}'
Response
{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "supersessionMode": "string",
  "conversionFactor": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "successorItemId": "xyz789",
  "discontinuationDate": "2026-01-01"
}
PATCH/itemSupersession

Update a item supersession

Update an existing item supersession, matched on `itemId`.

Body parameters

companyIdstringrequired

References company.id

supersessionModesupersessionModerequired
successorItemIdstring

References item.id

discontinuationDatedate
successorEffectivityDatedate
conversionFactornumberrequired
PATCHhttps://rest.carbon.ms/itemSupersession
curl --request PATCH \
  --url 'https://rest.carbon.ms/itemSupersession?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'
Response
{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "supersessionMode": "string",
  "conversionFactor": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "successorItemId": "xyz789",
  "discontinuationDate": "2026-01-01"
}
DELETE/itemSupersession

Delete a item supersession

Delete a item supersession, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the item supersession to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/itemSupersession
curl --request DELETE \
  --url 'https://rest.carbon.ms/itemSupersession?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content