Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /GetReturnItemsInfo

Response: List<OrderItemReturnInfo>



Use this call to get a list of all items on an order, including return quantities and resend quantities. The information can be used to calculate how many items has already been returned.

Parameters

NameTypeDescription
pkOrderIdGuidThe order id to get the returns for

HTTP Endpoint

Server /ProcessedOrders / GetReturnItemsInfo

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ProcessedOrders/GetReturnItemsInfo 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=ec5fb64f-c41c-4088-86b2-ff190236ae94

Response

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

[
  {
    "ChildItems": [
      {
      },
      {
      }
    ],
    "Batches": null,
    "fkOrderItemRowId": "3761f706-9e03-4440-8e3b-0dbffa70890c",
    "ParentRowId": "bc4c8a08-5b7d-40fa-b227-ed04acfed2af",
    "ReturnableQty": 0,
    "OrderQty": 3,
    "ReturnedQty": 4,
    "SKU": "sample string 5",
    "ItemTitle": "sample string 6",
    "UnitValue": 7.1,
    "TaxRate": 8.1,
    "TaxCostInclusive": true,
    "Currency": "sample string 10",
    "IsCompositeParent": true,
    "IsPartialCompositeReturn": true,
    "ParentRatio": 13,
    "pkStockItemId": "0af1d067-8ca9-495a-84f6-b588758fee16",
    "ResentQty": 14,
    "fkRefundRowId": "b067e143-fd85-44eb-8fc1-37ea58480f8a"
  },
  {
  }
]