Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /GetReturnsExchanges

Response: List<ReturnInfo>



Use this call to get a basic list of returns, exchanges and resends for an order.

Parameters

NameTypeDescription
pkOrderIdGuidThe order id to get the returns for

HTTP Endpoint

Server /ProcessedOrders / GetReturnsExchanges

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ProcessedOrders/GetReturnsExchanges 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=3d87d85d-40c8-490f-872b-b0b17e768f76

Response

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

[
  {
    "pkReturnId": 1,
    "RowType": 0,
    "ReturnReference": "sample string 2",
    "fkOrderId": "08b1edf1-1dab-44a9-b88f-65619b17c1d1",
    "fkOrderItemRowId": "1c6f1a8f-21ec-4227-8f19-3c98d80c6c1b",
    "OrderItemBatchId": 5,
    "nOrderId": 6,
    "SKU": "sample string 7",
    "ItemTitle": "sample string 8",
    "BatchNumber": "sample string 9",
    "Reason": "sample string 10",
    "ChannelReason": "sample string 11",
    "ChannelReasonSec": "sample string 12",
    "Category": "sample string 13",
    "ReturnQty": 14,
    "fkReturnLocationId": "1df6ea31-91ca-4d04-941c-68224c71e5cb",
    "Scrapped": true,
    "ScrapQty": 1,
    "LastState": "sample string 16",
    "LastDate": "2019-11-28T09:46:00.1271645+00:00",
    "Completed": true,
    "fkNewOrderId": "7c89cc13-cc27-4627-a04b-8e85e99974a0",
    "fkNewOrderItemRowId": "1f1af26c-23b9-4b91-acb2-f36e9014be1b",
    "fkNewStockItemId": "37c45e96-e9da-4588-81d1-a14556a01390",
    "NewQty": 1,
    "NewOrderId": 1,
    "NewOrderCancelled": true,
    "NewSKU": "sample string 20",
    "NewItemTitle": "sample string 21",
    "NewOrderProcessedOn": "2019-11-28T09:46:00.1281612+00:00",
    "AdditionalCost": 1.1,
    "fkRefundRowId": "3962f66b-513b-4173-abaf-9a22bb301691",
    "RefundedAmount": 1.1,
    "PendingRefund": 1.1,
    "ReturnDate": "2019-11-28T09:46:00.1281612+00:00"
  },
  {
    "pkReturnId": 1,
    "RowType": 0,
    "ReturnReference": "sample string 2",
    "fkOrderId": "08b1edf1-1dab-44a9-b88f-65619b17c1d1",
    "fkOrderItemRowId": "1c6f1a8f-21ec-4227-8f19-3c98d80c6c1b",
    "OrderItemBatchId": 5,
    "nOrderId": 6,
    "SKU": "sample string 7",
    "ItemTitle": "sample string 8",
    "BatchNumber": "sample string 9",
    "Reason": "sample string 10",
    "ChannelReason": "sample string 11",
    "ChannelReasonSec": "sample string 12",
    "Category": "sample string 13",
    "ReturnQty": 14,
    "fkReturnLocationId": "1df6ea31-91ca-4d04-941c-68224c71e5cb",
    "Scrapped": true,
    "ScrapQty": 1,
    "LastState": "sample string 16",
    "LastDate": "2019-11-28T09:46:00.1271645+00:00",
    "Completed": true,
    "fkNewOrderId": "7c89cc13-cc27-4627-a04b-8e85e99974a0",
    "fkNewOrderItemRowId": "1f1af26c-23b9-4b91-acb2-f36e9014be1b",
    "fkNewStockItemId": "37c45e96-e9da-4588-81d1-a14556a01390",
    "NewQty": 1,
    "NewOrderId": 1,
    "NewOrderCancelled": true,
    "NewSKU": "sample string 20",
    "NewItemTitle": "sample string 21",
    "NewOrderProcessedOn": "2019-11-28T09:46:00.1281612+00:00",
    "AdditionalCost": 1.1,
    "fkRefundRowId": "3962f66b-513b-4173-abaf-9a22bb301691",
    "RefundedAmount": 1.1,
    "PendingRefund": 1.1,
    "ReturnDate": "2019-11-28T09:46:00.1281612+00:00"
  }
]