Skip to content
aimrack

Sales Return Order Line

The sales return order line resource.

Base/salesReturnOrderLine
GET/salesReturnOrderLine

List sales return order lines

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

Retrieve a sales return order line

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

Query parameters

idstring

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

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

Create a sales return order line

Create a new sales return order line.

Body parameters

salesReturnOrderIdstringrequired
lineNumbernumberrequired
itemIdstringrequired

References item.id

quantitynumberrequired
quantityReceivednumberrequired
unitOfMeasureCodestring
unitPricenumberrequired
restockFeePercentnumberrequired
returnReasonIdstring
salesOrderLineIdstring

References salesOrderLine.id

shipmentLineIdstring

References shipmentLine.id

salesInvoiceLineIdstring

References salesInvoiceLine.id

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

Update a sales return order line

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

Body parameters

salesReturnOrderIdstringrequired
lineNumbernumberrequired
itemIdstringrequired

References item.id

quantitynumberrequired
quantityReceivednumberrequired
unitOfMeasureCodestring
unitPricenumberrequired
restockFeePercentnumberrequired
returnReasonIdstring
salesOrderLineIdstring

References salesOrderLine.id

shipmentLineIdstring

References shipmentLine.id

salesInvoiceLineIdstring

References salesInvoiceLine.id

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

Delete a sales return order line

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

Query parameters

idstring

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

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