Sales Order Transaction

The sales order transaction resource.

Base/salesOrderTransaction

GET/salesOrderTransaction

List sales order transactions

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

GET/salesOrderTransaction

curl --request GET \
  --url '<your-host>/salesOrderTransaction?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "salesOrderId": "xyz789",
    "type": "string",
    "userId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "companyId": "xyz789"
  }
]

GET/salesOrderTransaction

Retrieve a sales order transaction

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

Query parameters

idstring

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

GET/salesOrderTransaction

curl --request GET \
  --url '<your-host>/salesOrderTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "type": "string",
  "userId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyId": "xyz789"
}

POST/salesOrderTransaction

Create a sales order transaction

Create a new sales order transaction.

Body parameters

salesOrderIdstringrequired

References salesOrder.id

typesalesOrderTransactionTyperequired

userIdstringrequired

References user.id

companyIdstringrequired

POST/salesOrderTransaction

curl --request POST \
  --url <your-host>/salesOrderTransaction \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesOrderId":"xyz789","type":"string","userId":"xyz789","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "salesOrderId": "xyz789",
  "type": "string",
  "userId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyId": "xyz789"
}

PATCH/salesOrderTransaction

Update a sales order transaction

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

Body parameters

salesOrderIdstringrequired

References salesOrder.id

typesalesOrderTransactionTyperequired

userIdstringrequired

References user.id

companyIdstringrequired

PATCH/salesOrderTransaction

curl --request PATCH \
  --url '<your-host>/salesOrderTransaction?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",
  "type": "string",
  "userId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyId": "xyz789"
}

DELETE/salesOrderTransaction

Delete a sales order transaction

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

Query parameters

idstring

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

DELETE/salesOrderTransaction

curl --request DELETE \
  --url '<your-host>/salesOrderTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content