Sales Return Orders

The sales return orders resource.

Base/salesReturnOrders

GET/salesReturnOrders

List sales return orders

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

GET/salesReturnOrders

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "salesReturnOrderId": "xyz789",
    "status": "string",
    "customerId": "xyz789",
    "customerLocationId": "xyz789",
    "customerContactId": "xyz789",
    "customerReference": "string"
  }
]

GET/salesReturnOrders

Retrieve a sales return orders

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

Query parameters

idstring

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

GET/salesReturnOrders

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "salesReturnOrderId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "customerLocationId": "xyz789",
  "customerContactId": "xyz789",
  "customerReference": "string"
}