Sales Order

The sales order resource.

Basehttps://rest.carbon.ms/salesOrder

GET/salesOrder

List sales orders

Retrieve a paginated list of sales 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/salesOrder

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

Response

[
  {
    "id": "abc123def456",
    "salesOrderId": "xyz789",
    "revisionId": 0,
    "status": "string",
    "currencyCode": "string",
    "customerId": "xyz789",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/salesOrder

Retrieve a sales order

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesOrder

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "revisionId": 0,
  "status": "string",
  "currencyCode": "string",
  "customerId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/salesOrder

Create a sales order

Create a new sales order.

Body parameters

salesOrderIdstringrequired

revisionIdnumberrequired

statussalesOrderStatusrequired

orderDatedate

currencyCodestringrequired

References currencyCode.code

customerIdstringrequired

References customer.id

customerLocationIdstring

References customerLocation.id

customerContactIdstring

References customerContact.id

customerReferencestring

assigneestring

References user.id

companyIdstringrequired

References company.id

closedAtdate

closedBystring

References user.id

customFieldsobject

locationIdstring

References location.id

exchangeRatenumber

exchangeRateUpdatedAttimestamp

externalNotesobject

internalNotesobject

salesPersonIdstring

sentCompleteDatedate

opportunityIdstring

References opportunity.id

completedDatetimestamp

customerEngineeringContactIdstring

References customerContact.id

POSThttps://rest.carbon.ms/salesOrder

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "revisionId": 0,
  "status": "string",
  "currencyCode": "string",
  "customerId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/salesOrder

Update a sales order

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

Body parameters

salesOrderIdstringrequired

revisionIdnumberrequired

statussalesOrderStatusrequired

orderDatedate

currencyCodestringrequired

References currencyCode.code

customerIdstringrequired

References customer.id

customerLocationIdstring

References customerLocation.id

customerContactIdstring

References customerContact.id

customerReferencestring

assigneestring

References user.id

companyIdstringrequired

References company.id

closedAtdate

closedBystring

References user.id

customFieldsobject

locationIdstring

References location.id

exchangeRatenumber

exchangeRateUpdatedAttimestamp

externalNotesobject

internalNotesobject

salesPersonIdstring

sentCompleteDatedate

opportunityIdstring

References opportunity.id

completedDatetimestamp

customerEngineeringContactIdstring

References customerContact.id

PATCHhttps://rest.carbon.ms/salesOrder

curl --request PATCH \
  --url 'https://rest.carbon.ms/salesOrder?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",
  "revisionId": 0,
  "status": "string",
  "currencyCode": "string",
  "customerId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/salesOrder

Delete a sales order

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/salesOrder

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

204 No Content