Sales Orders

The sales orders resource.

Basehttps://rest.carbon.ms/salesOrders

GET/salesOrders

List sales orderss

Retrieve a paginated list of sales orderss. 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/salesOrders

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

Response

[
  {
    "id": "abc123def456",
    "salesOrderId": "xyz789",
    "revisionId": 0,
    "status": "string",
    "orderDate": "2026-01-01",
    "currencyCode": "string",
    "customerId": "xyz789",
    "customerLocationId": "xyz789"
  }
]

GET/salesOrders

Retrieve a sales orders

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesOrders

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "revisionId": 0,
  "status": "string",
  "orderDate": "2026-01-01",
  "currencyCode": "string",
  "customerId": "xyz789",
  "customerLocationId": "xyz789"
}