Sales Return Order

The sales return order resource.

Base/salesReturnOrder

GET/salesReturnOrder

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/salesReturnOrder

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "salesReturnOrderId": "xyz789",
    "status": "string",
    "customerId": "xyz789",
    "currencyCode": "string",
    "exchangeRate": 0,
    "orderDate": "2026-01-01"
  }
]

GET/salesReturnOrder

Retrieve a sales return order

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

Query parameters

idstring

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

GET/salesReturnOrder

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "salesReturnOrderId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "currencyCode": "string",
  "exchangeRate": 0,
  "orderDate": "2026-01-01"
}

POST/salesReturnOrder

Create a sales return order

Create a new sales return order.

Body parameters

salesReturnOrderIdstringrequired

statussalesReturnOrderStatusrequired

customerIdstringrequired

References customer.id

customerLocationIdstring

References customerLocation.id

customerContactIdstring

References customerContact.id

customerReferencestring

locationIdstring

References location.id

salesOrderIdstring

References salesOrder.id

replacementSalesOrderIdstring

References salesOrder.id

currencyCodestringrequired

exchangeRatenumberrequired

orderDatedaterequired

expirationDatedate

internalNotesobject

externalNotesobject

assigneestring

References user.id

customFieldsobject

POST/salesReturnOrder

curl --request POST \
  --url <your-host>/salesReturnOrder \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesReturnOrderId":"xyz789","status":"string","customerId":"xyz789","currencyCode":"string","exchangeRate":0,"orderDate":"2026-01-01"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "salesReturnOrderId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "currencyCode": "string",
  "exchangeRate": 0,
  "orderDate": "2026-01-01"
}

PATCH/salesReturnOrder

Update a sales return order

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

Body parameters

salesReturnOrderIdstringrequired

statussalesReturnOrderStatusrequired

customerIdstringrequired

References customer.id

customerLocationIdstring

References customerLocation.id

customerContactIdstring

References customerContact.id

customerReferencestring

locationIdstring

References location.id

salesOrderIdstring

References salesOrder.id

replacementSalesOrderIdstring

References salesOrder.id

currencyCodestringrequired

exchangeRatenumberrequired

orderDatedaterequired

expirationDatedate

internalNotesobject

externalNotesobject

assigneestring

References user.id

customFieldsobject

PATCH/salesReturnOrder

curl --request PATCH \
  --url '<your-host>/salesReturnOrder?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesReturnOrderId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "salesReturnOrderId": "xyz789",
  "status": "string",
  "customerId": "xyz789",
  "currencyCode": "string",
  "exchangeRate": 0,
  "orderDate": "2026-01-01"
}

DELETE/salesReturnOrder

Delete a sales return order

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

Query parameters

idstring

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

DELETE/salesReturnOrder

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

204 No Content