Purchase Return Orders

The purchase return orders resource.

Base/purchaseReturnOrders

GET/purchaseReturnOrders

List purchase return orders

Retrieve a paginated list of purchase 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/purchaseReturnOrders

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "purchaseReturnOrderId": "xyz789",
    "status": "string",
    "supplierId": "xyz789",
    "supplierLocationId": "xyz789",
    "supplierContactId": "xyz789",
    "supplierReference": "string"
  }
]

GET/purchaseReturnOrders

Retrieve a purchase return orders

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

Query parameters

idstring

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

GET/purchaseReturnOrders

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "purchaseReturnOrderId": "xyz789",
  "status": "string",
  "supplierId": "xyz789",
  "supplierLocationId": "xyz789",
  "supplierContactId": "xyz789",
  "supplierReference": "string"
}