Sales Order Lines

The sales order lines resource.

Basehttps://rest.carbon.ms/salesOrderLines

GET/salesOrderLines

List sales order liness

Retrieve a paginated list of sales order liness. 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/salesOrderLines

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

Response

[
  {
    "id": "abc123def456",
    "salesOrderId": "xyz789",
    "salesOrderLineType": "string",
    "itemId": "xyz789",
    "assetId": "xyz789",
    "description": "string",
    "saleQuantity": 10,
    "quantitySent": 10
  }
]

GET/salesOrderLines

Retrieve a sales order lines

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesOrderLines

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "salesOrderLineType": "string",
  "itemId": "xyz789",
  "assetId": "xyz789",
  "description": "string",
  "saleQuantity": 10,
  "quantitySent": 10
}