Purchase Return Order

The purchase return order resource.

Base/purchaseReturnOrder

GET/purchaseReturnOrder

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

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

Response

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

GET/purchaseReturnOrder

Retrieve a purchase return order

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

Query parameters

idstring

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

GET/purchaseReturnOrder

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

Response

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

POST/purchaseReturnOrder

Create a purchase return order

Create a new purchase return order.

Body parameters

purchaseReturnOrderIdstringrequired

statuspurchaseReturnOrderStatusrequired

supplierIdstringrequired

References supplier.id

supplierLocationIdstring

References supplierLocation.id

supplierContactIdstring

References supplierContact.id

supplierReferencestring

locationIdstring

References location.id

purchaseOrderIdstring

References purchaseOrder.id

replacementPurchaseOrderIdstring

References purchaseOrder.id

currencyCodestringrequired

exchangeRatenumberrequired

orderDatedaterequired

expirationDatedate

internalNotesobject

externalNotesobject

assigneestring

References user.id

customFieldsobject

POST/purchaseReturnOrder

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

Response

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

PATCH/purchaseReturnOrder

Update a purchase return order

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

Body parameters

purchaseReturnOrderIdstringrequired

statuspurchaseReturnOrderStatusrequired

supplierIdstringrequired

References supplier.id

supplierLocationIdstring

References supplierLocation.id

supplierContactIdstring

References supplierContact.id

supplierReferencestring

locationIdstring

References location.id

purchaseOrderIdstring

References purchaseOrder.id

replacementPurchaseOrderIdstring

References purchaseOrder.id

currencyCodestringrequired

exchangeRatenumberrequired

orderDatedaterequired

expirationDatedate

internalNotesobject

externalNotesobject

assigneestring

References user.id

customFieldsobject

PATCH/purchaseReturnOrder

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

Response

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

DELETE/purchaseReturnOrder

Delete a purchase return order

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

Query parameters

idstring

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

DELETE/purchaseReturnOrder

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

204 No Content