Carbon

Change Order Supersession

The change order supersession resource.

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

List change order supersessions

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

Retrieve a change order supersession

Fetch a single change order supersession by filtering on `id`.

Query parameters

idstring

Match on the change order supersession's `id`, e.g. `eq.{id}`.

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

Create a change order supersession

Create a new change order supersession.

Body parameters

changeOrderIdstringrequired

References changeOrder.id

predecessorItemIdstringrequired

References item.id

successorItemIdstring

References item.id

supersessionModesupersessionModerequired
discontinuationDatedate
successorEffectivityDatedate
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/changeOrderSupersession
curl --request POST \
  --url https://rest.carbon.ms/changeOrderSupersession \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"changeOrderId":"xyz789","predecessorItemId":"xyz789","supersessionMode":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "predecessorItemId": "xyz789",
  "supersessionMode": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "successorItemId": "xyz789"
}
PATCH/changeOrderSupersession

Update a change order supersession

Update an existing change order supersession, matched on `id`.

Body parameters

changeOrderIdstringrequired

References changeOrder.id

predecessorItemIdstringrequired

References item.id

successorItemIdstring

References item.id

supersessionModesupersessionModerequired
discontinuationDatedate
successorEffectivityDatedate
companyIdstringrequired

References company.id

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

Delete a change order supersession

Delete a change order supersession, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the change order supersession to delete, e.g. `eq.{id}`.

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