Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /ActionBookedOrder

Response: Void



Action list of booked returns/exchange items for a given order ID. If the return is for a batched item, the batch must be booked in manually.

Parameters

NameTypeDescription
pkOrderIdGuidunique ID of the order
bookedItemsList<BookedReturnsExchangeItem>list of returns/exchange items to be actioned

HTTP Endpoint

Server /ReturnsRefunds / ActionBookedOrder

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/ActionBookedOrder 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=8a443c1c-1dff-47bf-a258-b6829f30f2d7&bookedItems=[
  {
    "fkOrderItemRowId": "4b8b230e-6199-453c-9d6b-5d65324dd5eb",
    "OrderItemBatchId": 2,
    "StockItemId": "ea7077ee-ed36-4dee-a83f-38d4958ef3ba",
    "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": "a273189e-a7ef-4e24-a8b9-7f5f7a2f8c51",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "3b886464-715f-4921-bf52-32de20e5ad20",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "6c9cc28c-f271-4ced-a55a-07f7aed6d4ab",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2019-08-21T13:34:03.3001426+01:00",
    "DespatchUnitValue": 22.1,
    "BatchInventory": null
  },
  {
    "fkOrderItemRowId": "4b8b230e-6199-453c-9d6b-5d65324dd5eb",
    "OrderItemBatchId": 2,
    "StockItemId": "ea7077ee-ed36-4dee-a83f-38d4958ef3ba",
    "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": "a273189e-a7ef-4e24-a8b9-7f5f7a2f8c51",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "3b886464-715f-4921-bf52-32de20e5ad20",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "6c9cc28c-f271-4ced-a55a-07f7aed6d4ab",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2019-08-21T13:34:03.3001426+01:00",
    "DespatchUnitValue": 22.1,
    "BatchInventory": null
  }
]

Response

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

null