| Name | Type | Description |
|---|---|---|
| pkOrderId | Guid | The order id |
| exchangeItems | List<RowQty> | A list of items to be exchanged, including quantity, scrap, refund, etc. |
| despatchLocation | Guid | The id of the location to despatch replacement items from |
| returnLocation | Guid | The id of the location to return stock to |
| channelReason | String | Channel reason - required if a refund on the channel is required |
| channelSubReason | String | Channel subreason - required if a refund on the channel is required. |
| category | String | The refund category |
| reason | String | The reason for the reason |
| isBooking | Boolean | True if it is a exchange booking, False if it is a new exchange |
| ignoredValidation | Boolean | True if failed validation has been ignored (see IsRefundValid). Otherwise, false. When set to true, refunds will not be automatically actioned on the channel. Ignored if creating a booking as a refund is not created at this stage. |
The following request format is required for this method.
POST https://eu-ext.linnworks.net//api/ProcessedOrders/CreateExchange 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=f8ae12e3-941e-4658-a96f-d8b757abbe73&exchangeItems=[
{
"OrderItemRowId": "b9fa2e43-e578-46e4-a951-20c32241d083",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "277ebc7d-f4d1-44cc-bcdf-b19e7d1903a0",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "28582847-b632-4189-adba-00f96b0dbacd",
"BatchNumber": "sample string 5",
"ExpiresOn": "2019-11-28T09:45:57.417456+00:00",
"SellBy": "2019-11-28T09:45:57.417456+00:00",
"Inventory": [
null,
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "c6fa8e71-1c10-43fe-add7-af39b98e4553",
"BinRack": "sample string 4",
"PrioritySequence": 5,
"Quantity": 6,
"StockValue": 7.0,
"StartQuantity": 8,
"PickedQuantity": 9,
"BatchStatus": "Available",
"IsDeleted": false,
"WarehouseBinrackStandardType": null,
"WarehouseBinrackTypeName": null,
"InTransfer": null,
"BinRackId": null
}
],
"IsDeleted": true
},
"DespatchUnitValue": 0.0,
"AssignmentType": 0
},
"AdditionalCost": 4.1,
"NewStockItemId": "be150db4-6214-4358-85e1-455f20e7be0a",
"NewQty": 5
},
{
"OrderItemRowId": "b9fa2e43-e578-46e4-a951-20c32241d083",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "277ebc7d-f4d1-44cc-bcdf-b19e7d1903a0",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "28582847-b632-4189-adba-00f96b0dbacd",
"BatchNumber": "sample string 5",
"ExpiresOn": "2019-11-28T09:45:57.417456+00:00",
"SellBy": "2019-11-28T09:45:57.417456+00:00",
"Inventory": [
null,
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "c6fa8e71-1c10-43fe-add7-af39b98e4553",
"BinRack": "sample string 4",
"PrioritySequence": 5,
"Quantity": 6,
"StockValue": 7.0,
"StartQuantity": 8,
"PickedQuantity": 9,
"BatchStatus": "Available",
"IsDeleted": false,
"WarehouseBinrackStandardType": null,
"WarehouseBinrackTypeName": null,
"InTransfer": null,
"BinRackId": null
}
],
"IsDeleted": true
},
"DespatchUnitValue": 0.0,
"AssignmentType": 0
},
"AdditionalCost": 4.1,
"NewStockItemId": "be150db4-6214-4358-85e1-455f20e7be0a",
"NewQty": 5
}
]&despatchLocation=33998135-5390-4420-9bee-bcf761d629a4&returnLocation=5f008686-7d56-4eb3-8a58-61457a2cd381&channelReason=sample string 1&channelSubReason=sample string 1&category=sample string 1&reason=sample string 1&isBooking=true&ignoredValidation=true
This is an example response. Results may vary depending on your data.
[
{
"pkReturnId": 1,
"RowType": 0,
"ReturnReference": "sample string 2",
"fkOrderId": "41942f98-cfe2-4372-8c82-cf0366a99c9e",
"fkOrderItemRowId": "18b901f7-2ef2-4458-b6b5-8104d506be8d",
"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": "0cc79b83-39af-4c3c-aae8-1f9518b86155",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2019-11-28T09:46:00.2995092+00:00",
"Completed": true,
"fkNewOrderId": "bab2858b-e3cc-4057-a5d1-0732bc35b7c0",
"fkNewOrderItemRowId": "63232ef8-43f2-4c58-aaf7-3f9f9aa18f71",
"fkNewStockItemId": "2c69a004-9db3-4dec-bdb6-c30eba2117fa",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2019-11-28T09:46:00.2995092+00:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "04619fe0-5bd6-4871-a1fa-d7e2351dc859",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2019-11-28T09:46:00.2995092+00:00"
},
{
"pkReturnId": 1,
"RowType": 0,
"ReturnReference": "sample string 2",
"fkOrderId": "41942f98-cfe2-4372-8c82-cf0366a99c9e",
"fkOrderItemRowId": "18b901f7-2ef2-4458-b6b5-8104d506be8d",
"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": "0cc79b83-39af-4c3c-aae8-1f9518b86155",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2019-11-28T09:46:00.2995092+00:00",
"Completed": true,
"fkNewOrderId": "bab2858b-e3cc-4057-a5d1-0732bc35b7c0",
"fkNewOrderItemRowId": "63232ef8-43f2-4c58-aaf7-3f9f9aa18f71",
"fkNewStockItemId": "2c69a004-9db3-4dec-bdb6-c30eba2117fa",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2019-11-28T09:46:00.2995092+00:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "04619fe0-5bd6-4871-a1fa-d7e2351dc859",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2019-11-28T09:46:00.2995092+00:00"
}
]