Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetBookedReturnsExchangeItems

Response: List<BookedReturnsExchangeItem>



Gets all booked returns/exchange order items for a given order ID

Parameters

NameTypeDescription
pkOrderIdGuid

HTTP Endpoint

Server /ReturnsRefunds / GetBookedReturnsExchangeItems

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsRefundsNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/GetBookedReturnsExchangeItems HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

pkOrderId=36742435-9724-4893-a3e9-5352432a2b55

Response

This is an example response. Results may vary depending on your data.

[
  {
    "fkOrderItemRowId": "1bc8a09e-771d-4741-b37c-806de20c0025",
    "OrderItemBatchId": 2,
    "StockItemId": "b8ffd8a4-7f52-425a-b49d-752db4117c3a",
    "BatchInventoryId": 1,
    "BatchNumber": "sample string 3",
    "RowType": "sample string 4",
    "SKU": "sample string 5",
    "ItemTitle": "sample string 6",
    "ReturnQty": 7,
    "MaxReturnQty": 8,
    "NewQty": 1,
    "NewSKU": "sample string 9",
    "NewTitle": "sample string 10",
    "fkNewStockItemId": "728262b9-50c4-4bab-bb6d-3f4c725373db",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "b0eb4199-a104-4de7-a924-cc722a925d66",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "fa458a69-9379-484a-ab4c-bcc38bc8598d",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2018-02-19T16:57:07.5881959+00:00",
    "DespatchUnitValue": 22.1
  },
  {
    "fkOrderItemRowId": "1bc8a09e-771d-4741-b37c-806de20c0025",
    "OrderItemBatchId": 2,
    "StockItemId": "b8ffd8a4-7f52-425a-b49d-752db4117c3a",
    "BatchInventoryId": 1,
    "BatchNumber": "sample string 3",
    "RowType": "sample string 4",
    "SKU": "sample string 5",
    "ItemTitle": "sample string 6",
    "ReturnQty": 7,
    "MaxReturnQty": 8,
    "NewQty": 1,
    "NewSKU": "sample string 9",
    "NewTitle": "sample string 10",
    "fkNewStockItemId": "728262b9-50c4-4bab-bb6d-3f4c725373db",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "b0eb4199-a104-4de7-a924-cc722a925d66",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "fa458a69-9379-484a-ab4c-bcc38bc8598d",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2018-02-19T16:57:07.5881959+00:00",
    "DespatchUnitValue": 22.1
  }
]