| 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=f4061537-e7f7-40f7-9fa5-2d9ea4b5edd5&exchangeItems=[
{
"OrderItemRowId": "72846d45-7c8d-4b83-91a1-9528f97cfe17",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "0cd48316-d355-434c-abd8-dd10bdde8ef3",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "a22f2013-1431-468a-8829-1f68bf6fa937",
"BatchNumber": "sample string 5",
"ExpiresOn": "2019-06-12T09:27:49.6890068+01:00",
"SellBy": "2019-06-12T09:27:49.6890068+01:00",
"Inventory": [
null,
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "501f9571-8ec7-4563-b104-4dbb6d339498",
"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": "7ad1bef2-46e5-4c61-8c78-2a870c2f18d5",
"NewQty": 5
},
{
"OrderItemRowId": "72846d45-7c8d-4b83-91a1-9528f97cfe17",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "0cd48316-d355-434c-abd8-dd10bdde8ef3",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "a22f2013-1431-468a-8829-1f68bf6fa937",
"BatchNumber": "sample string 5",
"ExpiresOn": "2019-06-12T09:27:49.6890068+01:00",
"SellBy": "2019-06-12T09:27:49.6890068+01:00",
"Inventory": [
null,
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "501f9571-8ec7-4563-b104-4dbb6d339498",
"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": "7ad1bef2-46e5-4c61-8c78-2a870c2f18d5",
"NewQty": 5
}
]&despatchLocation=2d8659a0-7e80-4139-be44-a53da9799823&returnLocation=27fc01c9-e399-4f59-8a89-98098d771b71&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": "d90913c6-70f1-4106-94c1-2c638dbebe94",
"fkOrderItemRowId": "92b9310b-5c60-440b-a434-d9e57d22fc72",
"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": "f0695826-23ac-4e68-9c9b-9a6cbe17f7f9",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2019-06-12T09:27:51.7044044+01:00",
"Completed": true,
"fkNewOrderId": "9476a70c-aac1-47ac-b45b-01b353b1c169",
"fkNewOrderItemRowId": "2fb96085-c402-49d7-8822-2d0ab2bc7d4b",
"fkNewStockItemId": "42dbf44c-d38a-41e2-a7ed-b979142cf328",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2019-06-12T09:27:51.7044044+01:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "8ba30f0c-a6a6-49f1-91c7-d903a010c539",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2019-06-12T09:27:51.7044044+01:00"
},
{
"pkReturnId": 1,
"RowType": 0,
"ReturnReference": "sample string 2",
"fkOrderId": "d90913c6-70f1-4106-94c1-2c638dbebe94",
"fkOrderItemRowId": "92b9310b-5c60-440b-a434-d9e57d22fc72",
"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": "f0695826-23ac-4e68-9c9b-9a6cbe17f7f9",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2019-06-12T09:27:51.7044044+01:00",
"Completed": true,
"fkNewOrderId": "9476a70c-aac1-47ac-b45b-01b353b1c169",
"fkNewOrderItemRowId": "2fb96085-c402-49d7-8822-2d0ab2bc7d4b",
"fkNewStockItemId": "42dbf44c-d38a-41e2-a7ed-b979142cf328",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2019-06-12T09:27:51.7044044+01:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "8ba30f0c-a6a6-49f1-91c7-d903a010c539",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2019-06-12T09:27:51.7044044+01:00"
}
]