Change Order

The change order resource.

Basehttps://rest.carbon.ms/changeOrder

GET/changeOrder

List change orders

Retrieve a paginated list of change orders. 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/changeOrder

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

Response

[
  {
    "id": "abc123def456",
    "changeOrderId": "xyz789",
    "name": "Example",
    "reasonForChange": "string",
    "description": "string",
    "type": "string",
    "status": "string",
    "openDate": "2026-01-01"
  }
]

GET/changeOrder

Retrieve a change order

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/changeOrder

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

Response

{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "name": "Example",
  "reasonForChange": "string",
  "description": "string",
  "type": "string",
  "status": "string",
  "openDate": "2026-01-01"
}

POST/changeOrder

Create a change order

Create a new change order.

Body parameters

changeOrderIdstringrequired

namestringrequired

reasonForChangeobjectrequired

descriptionobjectrequired

typechangeOrderTypeEnumrequired

statuschangeOrderStatusrequired

prioritynonConformancePriority

changeOrderTypeIdstring

References changeOrderType.id

nonConformanceIdstring

References nonConformance.id

openDatedaterequired

dueDatedate

requiredActionIdsarray

approvalRequirementsarray

sourceTypestring

sourceIdstring

assigneestring

References user.id

customFieldsobject

tagsarray

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/changeOrder

curl --request POST \
  --url https://rest.carbon.ms/changeOrder \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"changeOrderId":"xyz789","name":"Example","reasonForChange":"string","description":"string","type":"string","status":"string","openDate":"2026-01-01","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "changeOrderId": "xyz789",
  "name": "Example",
  "reasonForChange": "string",
  "description": "string",
  "type": "string",
  "status": "string",
  "openDate": "2026-01-01"
}

PATCH/changeOrder

Update a change order

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

Body parameters

changeOrderIdstringrequired

namestringrequired

reasonForChangeobjectrequired

descriptionobjectrequired

typechangeOrderTypeEnumrequired

statuschangeOrderStatusrequired

prioritynonConformancePriority

changeOrderTypeIdstring

References changeOrderType.id

nonConformanceIdstring

References nonConformance.id

openDatedaterequired

dueDatedate

requiredActionIdsarray

approvalRequirementsarray

sourceTypestring

sourceIdstring

assigneestring

References user.id

customFieldsobject

tagsarray

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/changeOrder

curl --request PATCH \
  --url 'https://rest.carbon.ms/changeOrder?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",
  "name": "Example",
  "reasonForChange": "string",
  "description": "string",
  "type": "string",
  "status": "string",
  "openDate": "2026-01-01"
}

DELETE/changeOrder

Delete a change order

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/changeOrder

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

204 No Content