Sales Order Status History

The sales order status history resource.

Basehttps://rest.carbon.ms/salesOrderStatusHistory

GET/salesOrderStatusHistory

List sales order status historys

Retrieve a paginated list of sales order status historys. 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/salesOrderStatusHistory

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

Response

[
  {
    "id": "abc123def456",
    "salesOrderId": "xyz789",
    "status": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/salesOrderStatusHistory

Retrieve a sales order status history

Fetch a single sales order status history by filtering on `id`.

Query parameters

idstring

Match on the sales order status history's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/salesOrderStatusHistory

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/salesOrderStatusHistory

Create a sales order status history

Create a new sales order status history.

Body parameters

salesOrderIdstringrequired

References salesOrder.id

statussalesOrderStatusrequired

POSThttps://rest.carbon.ms/salesOrderStatusHistory

curl --request POST \
  --url https://rest.carbon.ms/salesOrderStatusHistory \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesOrderId":"xyz789","status":"string"}'

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/salesOrderStatusHistory

Update a sales order status history

Update an existing sales order status history, matched on `id`.

Body parameters

salesOrderIdstringrequired

References salesOrder.id

statussalesOrderStatusrequired

PATCHhttps://rest.carbon.ms/salesOrderStatusHistory

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/salesOrderStatusHistory

Delete a sales order status history

Delete a sales order status history, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the sales order status history to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/salesOrderStatusHistory

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

204 No Content