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=baa64427-bb53-4c1e-b500-549454ed3570&bookedItems=[
  {
    "fkOrderItemRowId": "d8fb6e17-240e-4c33-9c34-19c5f9680070",
    "OrderItemBatchId": 2,
    "StockItemId": "7a63faa1-6b2c-4453-ba46-2841eb8b5e65",
    "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": "397298c8-c897-4f4f-8966-a26901b6c163",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "d4e28d19-22c8-4ee8-b4d5-dadd9ea6518a",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "86a86740-c49d-4d84-883c-91e471492bb2",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2018-10-03T11:12:32.9654282+01:00",
    "DespatchUnitValue": 22.1,
    "BatchInventory": null
  },
  {
    "fkOrderItemRowId": "d8fb6e17-240e-4c33-9c34-19c5f9680070",
    "OrderItemBatchId": 2,
    "StockItemId": "7a63faa1-6b2c-4453-ba46-2841eb8b5e65",
    "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": "397298c8-c897-4f4f-8966-a26901b6c163",
    "Category": "sample string 11",
    "Reason": "sample string 12",
    "fkReturnLocationId": "d4e28d19-22c8-4ee8-b4d5-dadd9ea6518a",
    "ReturnLocation": "sample string 14",
    "PendingRefundAmount": 1.1,
    "Scrapped": true,
    "ScrapQty": 1,
    "ParentOrderItemRowId": "86a86740-c49d-4d84-883c-91e471492bb2",
    "AdditionalCost": 1.1,
    "cCurrency": "sample string 17",
    "pkReturnId": 18,
    "ChannelReason": "sample string 19",
    "ChannelReasonSec": "sample string 20",
    "ReturnDate": "2018-10-03T11:12:32.9654282+01:00",
    "DespatchUnitValue": 22.1,
    "BatchInventory": null
  }
]

Response

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

null