Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ProcessedOrders /GetReturnsExchanges

Allows 150 calls per minute

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

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ProcessedOrders/GetReturnsExchanges

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

pkOrderId=e27c59e5-a010-43cf-aea2-7ea0280c8229

Response

This is an example of the response JSON. Results will vary depending on your data.

[
  {
    "pkReturnId": 1,
    "RowType": 0,
    "ReturnReference": "sample string 2",
    "fkOrderId": "23d70b2b-7500-41a4-a598-ea9358ceea3f",
    "fkOrderItemRowId": "512473cc-cb56-480c-8eb6-9006ccb9b5ba",
    "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": "58b495e2-f53a-4f5b-816b-737327d8caa2",
    "Scrapped": true,
    "ScrapQty": 1,
    "LastState": "sample string 16",
    "LastDate": "2021-07-29T09:24:42.2182149+01:00",
    "Completed": true,
    "fkNewOrderId": "908fbd11-b6c9-4f8e-8583-8019ed1cb7d6",
    "fkNewOrderItemRowId": "b58dd75b-9410-42d3-b051-e467c2ac55da",
    "fkNewStockItemId": "263d6891-dc99-4304-9ea0-5f33224f64b7",
    "NewQty": 1,
    "NewOrderId": 1,
    "NewOrderCancelled": true,
    "NewSKU": "sample string 20",
    "NewItemTitle": "sample string 21",
    "NewOrderProcessedOn": "2021-07-29T09:24:42.2182149+01:00",
    "AdditionalCost": 1.1,
    "fkRefundRowId": "ae7f7e8e-d865-45d1-a3fb-82d2c61a6efb",
    "RefundedAmount": 1.1,
    "PendingRefund": 1.1,
    "ReturnDate": "2021-07-29T09:24:42.2192153+01:00"
  }
]