Sales Order Line

The sales order line resource.

Basehttps://rest.carbon.ms/salesOrderLine

GET/salesOrderLine

List sales order lines

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

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

Response

[
  {
    "id": "abc123def456",
    "salesOrderId": "xyz789",
    "salesOrderLineType": "string",
    "sentComplete": true,
    "invoicedComplete": true,
    "requiresInspection": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/salesOrderLine

Retrieve a sales order line

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesOrderLine

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

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "salesOrderLineType": "string",
  "sentComplete": true,
  "invoicedComplete": true,
  "requiresInspection": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/salesOrderLine

Create a sales order line

Create a new sales order line.

Body parameters

salesOrderIdstringrequired

References salesOrder.id

salesOrderLineTypesalesOrderLineTyperequired

itemIdstring

References item.id

assetIdstring

descriptionstring

saleQuantitynumber

quantitySentnumber

quantityInvoicednumber

unitPricenumber

unitOfMeasureCodestring

locationIdstring

storageUnitIdstring

References storageUnit.id

setupPricenumber

sentCompletebooleanrequired

invoicedCompletebooleanrequired

requiresInspectionbooleanrequired

companyIdstringrequired

customFieldsobject

statussalesOrderLineStatusrequired

modelUploadIdstring

promisedDatedate

addOnCostnumberrequired

methodTypemethodTyperequired

exchangeRatenumber

shippingCostnumberrequired

taxPercentnumberrequired

internalNotesobject

externalNotesobject

quantityToSendnumber

quantityToInvoicenumber

convertedAddOnCostnumber

convertedShippingCostnumber

convertedUnitPricenumber

sentDatedate

accountIdstring

References account.id

nonTaxableAddOnCostnumberrequired

convertedNonTaxableAddOnCostnumber

pricingRuleIdstring

References pricingRule.id

priceTraceobject

POSThttps://rest.carbon.ms/salesOrderLine

curl --request POST \
  --url https://rest.carbon.ms/salesOrderLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesOrderId":"xyz789","salesOrderLineType":"string","description":"string","sentComplete":true,"invoicedComplete":true,"requiresInspection":true,"companyId":"xyz789","status":"string","addOnCost":0,"methodType":"string","shippingCost":0,"taxPercent":0,"nonTaxableAddOnCost":0}'

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "salesOrderLineType": "string",
  "sentComplete": true,
  "invoicedComplete": true,
  "requiresInspection": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/salesOrderLine

Update a sales order line

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

Body parameters

salesOrderIdstringrequired

References salesOrder.id

salesOrderLineTypesalesOrderLineTyperequired

itemIdstring

References item.id

assetIdstring

descriptionstring

saleQuantitynumber

quantitySentnumber

quantityInvoicednumber

unitPricenumber

unitOfMeasureCodestring

locationIdstring

storageUnitIdstring

References storageUnit.id

setupPricenumber

sentCompletebooleanrequired

invoicedCompletebooleanrequired

requiresInspectionbooleanrequired

companyIdstringrequired

customFieldsobject

statussalesOrderLineStatusrequired

modelUploadIdstring

promisedDatedate

addOnCostnumberrequired

methodTypemethodTyperequired

exchangeRatenumber

shippingCostnumberrequired

taxPercentnumberrequired

internalNotesobject

externalNotesobject

quantityToSendnumber

quantityToInvoicenumber

convertedAddOnCostnumber

convertedShippingCostnumber

convertedUnitPricenumber

sentDatedate

accountIdstring

References account.id

nonTaxableAddOnCostnumberrequired

convertedNonTaxableAddOnCostnumber

pricingRuleIdstring

References pricingRule.id

priceTraceobject

PATCHhttps://rest.carbon.ms/salesOrderLine

curl --request PATCH \
  --url 'https://rest.carbon.ms/salesOrderLine?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",
  "salesOrderLineType": "string",
  "sentComplete": true,
  "invoicedComplete": true,
  "requiresInspection": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/salesOrderLine

Delete a sales order line

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/salesOrderLine

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

204 No Content