getSalesReturnOrderLines

READ

Get sales return order lines.

POST /api/v1/sales/getSalesReturnOrderLines

curl -X POST '<your-host>/api/v1/sales/getSalesReturnOrderLines' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salesReturnOrderId": "string"
  }'

Response

{
  "results": [
    {
      "closedComplete": true,
      "companyId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "customFields": "…",
      "disposition": "Pending",
      "id": "string",
      "itemId": "string",
      "lineNumber": 0,
      "quantity": 0,
      "quantityReceived": 0,
      "restockFeePercent": 0,
      "returnReasonId": "string",
      "salesInvoiceLineId": "string",
      "salesOrderLineId": "string",
      "salesReturnOrderId": "string",
      "shipmentLineId": "string",
      "unitOfMeasureCode": "string",
      "unitPrice": 0,
      "updatedAt": "string",
      "updatedBy": "string",
      "returnReason": {
        "name": "string"
      },
      "item": {
        "name": "string",
        "readableIdWithRevision": "string",
        "itemTrackingType": "Inventory",
        "thumbnailPath": "string"
      }
    }
  ],
  "count": null
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "salesReturnOrderId": {
      "type": "string"
    }
  },
  "required": [
    "salesReturnOrderId"
  ]
}