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.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=abcf5aaf-1695-4c06-b62f-b24a68298167

Response

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

[
  {
    "fkOrderItemRowId": "3666e389-d826-43fa-9a78-cb7540a1e876",
    "OrderItemBatchId": 2,
    "StockItemId": "ae86a9fd-1596-4d9c-b4ad-b8237f4651cf",
    "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": "00fb4423-2bdc-4425-a9dd-e4b3cf0d502d",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "d2ad7124-a1f0-49b0-95d5-b8e4bad63171",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "12fbac5f-c6a4-4b92-ba4b-745995f0bd0d",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2018-10-03T11:12:35.1639773+01:00",
    "DespatchUnitValue": 22.1,
    "BatchInventory": null
  },
  {
    "fkOrderItemRowId": "3666e389-d826-43fa-9a78-cb7540a1e876",
    "OrderItemBatchId": 2,
    "StockItemId": "ae86a9fd-1596-4d9c-b4ad-b8237f4651cf",
    "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": "00fb4423-2bdc-4425-a9dd-e4b3cf0d502d",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "d2ad7124-a1f0-49b0-95d5-b8e4bad63171",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "12fbac5f-c6a4-4b92-ba4b-745995f0bd0d",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2018-10-03T11:12:35.1639773+01:00",
    "DespatchUnitValue": 22.1,
    "BatchInventory": null
  }
]