| 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=bc5d6e35-fe46-4b26-ba1a-d3f468235a51&exchangeItems=[
{
"OrderItemRowId": "605cf977-6cef-4d93-8e14-1a270f5e7f85",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "08c3ff6e-7cb3-43b7-be8a-16907b80a921",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "c556012f-38ae-4b36-9c1e-9472e528444c",
"BatchNumber": "sample string 5",
"ExpiresOn": "2019-07-23T15:31:53.8966533+01:00",
"SellBy": "2019-07-23T15:31:53.8966533+01:00",
"Inventory": [
null,
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "d77407c6-211a-4917-94fe-2f01bdde2468",
"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": "9c94f08f-bf03-4b88-aed9-ac4b0aca02a0",
"NewQty": 5
},
{
"OrderItemRowId": "605cf977-6cef-4d93-8e14-1a270f5e7f85",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "08c3ff6e-7cb3-43b7-be8a-16907b80a921",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "c556012f-38ae-4b36-9c1e-9472e528444c",
"BatchNumber": "sample string 5",
"ExpiresOn": "2019-07-23T15:31:53.8966533+01:00",
"SellBy": "2019-07-23T15:31:53.8966533+01:00",
"Inventory": [
null,
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "d77407c6-211a-4917-94fe-2f01bdde2468",
"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": "9c94f08f-bf03-4b88-aed9-ac4b0aca02a0",
"NewQty": 5
}
]&despatchLocation=8dde8cf8-f15e-4238-946b-11a2a55a30d4&returnLocation=78e1a781-7544-4b90-b6d4-4d519dd376e2&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": "4466758d-1237-4eb1-8cf2-c66e44243311",
"fkOrderItemRowId": "a0cf08fd-6c93-45f5-8fdd-ea7a6215b855",
"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": "3b874ae6-825e-4fc0-9e81-3f65670a525d",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2019-07-23T15:31:55.7050033+01:00",
"Completed": true,
"fkNewOrderId": "503ddb1f-f39e-4465-a176-ad10c3fd3360",
"fkNewOrderItemRowId": "46a78126-b338-4ffe-b782-4c4b3c508c5d",
"fkNewStockItemId": "bf65031e-e5e4-4dec-8e31-e81fc0e4e79a",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2019-07-23T15:31:55.7050033+01:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "5c46be5a-0d65-465f-9bba-1e0d0e9e1947",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2019-07-23T15:31:55.7050033+01:00"
},
{
"pkReturnId": 1,
"RowType": 0,
"ReturnReference": "sample string 2",
"fkOrderId": "4466758d-1237-4eb1-8cf2-c66e44243311",
"fkOrderItemRowId": "a0cf08fd-6c93-45f5-8fdd-ea7a6215b855",
"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": "3b874ae6-825e-4fc0-9e81-3f65670a525d",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2019-07-23T15:31:55.7050033+01:00",
"Completed": true,
"fkNewOrderId": "503ddb1f-f39e-4465-a176-ad10c3fd3360",
"fkNewOrderItemRowId": "46a78126-b338-4ffe-b782-4c4b3c508c5d",
"fkNewStockItemId": "bf65031e-e5e4-4dec-8e31-e81fc0e4e79a",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2019-07-23T15:31:55.7050033+01:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "5c46be5a-0d65-465f-9bba-1e0d0e9e1947",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2019-07-23T15:31:55.7050033+01:00"
}
]