Skip to content
aimrack

Purchase Return Order Line

The purchase return order line resource.

Base/purchaseReturnOrderLine
GET/purchaseReturnOrderLine

List purchase return order lines

Retrieve a paginated list of purchase return order lines. 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/purchaseReturnOrderLine
curl --request GET \
  --url '<your-host>/purchaseReturnOrderLine?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "purchaseReturnOrderId": "xyz789",
    "lineNumber": 0,
    "itemId": "xyz789",
    "quantity": 10,
    "quantityShipped": 10,
    "unitPrice": 0
  }
]
GET/purchaseReturnOrderLine

Retrieve a purchase return order line

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

Query parameters

idstring

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

GET/purchaseReturnOrderLine
curl --request GET \
  --url '<your-host>/purchaseReturnOrderLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "purchaseReturnOrderId": "xyz789",
  "lineNumber": 0,
  "itemId": "xyz789",
  "quantity": 10,
  "quantityShipped": 10,
  "unitPrice": 0
}
POST/purchaseReturnOrderLine

Create a purchase return order line

Create a new purchase return order line.

Body parameters

purchaseReturnOrderIdstringrequired
lineNumbernumberrequired
itemIdstringrequired

References item.id

quantitynumberrequired
quantityShippednumberrequired
unitOfMeasureCodestring
unitPricenumberrequired
restockFeePercentnumberrequired
returnReasonIdstring
purchaseOrderLineIdstring

References purchaseOrderLine.id

receiptLineIdstring

References receiptLine.id

purchaseInvoiceLineIdstring

References purchaseInvoiceLine.id

closedCompletebooleanrequired
customFieldsobject
POST/purchaseReturnOrderLine
curl --request POST \
  --url <your-host>/purchaseReturnOrderLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"purchaseReturnOrderId":"xyz789","lineNumber":0,"itemId":"xyz789","quantity":10,"quantityShipped":10,"unitPrice":0,"restockFeePercent":0,"closedComplete":true}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "purchaseReturnOrderId": "xyz789",
  "lineNumber": 0,
  "itemId": "xyz789",
  "quantity": 10,
  "quantityShipped": 10,
  "unitPrice": 0
}
PATCH/purchaseReturnOrderLine

Update a purchase return order line

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

Body parameters

purchaseReturnOrderIdstringrequired
lineNumbernumberrequired
itemIdstringrequired

References item.id

quantitynumberrequired
quantityShippednumberrequired
unitOfMeasureCodestring
unitPricenumberrequired
restockFeePercentnumberrequired
returnReasonIdstring
purchaseOrderLineIdstring

References purchaseOrderLine.id

receiptLineIdstring

References receiptLine.id

purchaseInvoiceLineIdstring

References purchaseInvoiceLine.id

closedCompletebooleanrequired
customFieldsobject
PATCH/purchaseReturnOrderLine
curl --request PATCH \
  --url '<your-host>/purchaseReturnOrderLine?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",
  "lineNumber": 0,
  "itemId": "xyz789",
  "quantity": 10,
  "quantityShipped": 10,
  "unitPrice": 0
}
DELETE/purchaseReturnOrderLine

Delete a purchase return order line

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

Query parameters

idstring

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

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