| 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/CreateExchangeConnection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
This is an example of the request structure. Results will vary depending on your data.
pkOrderId=134e4e07-17b6-4fd7-b627-3d37b61eee7a&exchangeItems=[
{
"OrderItemRowId": "c4242563-7767-4d76-a3b4-d074c6bdc130",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "963cf63a-a0a6-4661-b2c5-5f89e8e21ea7",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "7eb54314-9765-4e75-bc11-d3f67dc120ed",
"BatchNumber": "sample string 5",
"ExpiresOn": "2021-07-29T09:24:11.8103355+01:00",
"SellBy": "2021-07-29T09:24:11.8103355+01:00",
"Inventory": [
{
"BatchInventoryId": 0,
"BatchId": 0,
"StockLocationId": "00000000-0000-0000-0000-000000000000",
"BinRack": "Available",
"PrioritySequence": 0,
"Quantity": 0,
"StockValue": 0.0,
"StartQuantity": 0,
"PickedQuantity": 0,
"BatchStatus": "Available",
"IsDeleted": false,
"WarehouseBinrackStandardType": null,
"WarehouseBinrackTypeName": "Available",
"InTransfer": null,
"BinRackId": null,
"WarehouseBinrackTypeId": null
}
],
"IsDeleted": true
},
"DespatchUnitValue": 0.0,
"AssignmentType": 0
},
"AdditionalCost": 4.1,
"NewStockItemId": "15120662-33ff-4f59-940c-85ff1d9b941e",
"NewQty": 5
}
]&despatchLocation=acba1b82-759b-4278-a73b-1f07cdfc13ba&returnLocation=c3b71439-c516-4dbc-85ab-b4711fd21c2b&channelReason=sample string 1&channelSubReason=sample string 1&category=sample string 1&reason=sample string 1&isBooking=true&ignoredValidation=trueThis is an example of the response JSON. Results will vary depending on your data.
[
{
"pkReturnId": 1,
"RowType": 0,
"ReturnReference": "sample string 2",
"fkOrderId": "e1a527b6-4271-4710-9854-394f81b2ed1b",
"fkOrderItemRowId": "66ded249-0c02-4556-9639-359833355994",
"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": "a4d86174-8b45-4ace-ae3c-5ec993cfef51",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2021-07-29T09:24:42.3792173+01:00",
"Completed": true,
"fkNewOrderId": "b8be1f37-7241-4f1b-8ce0-6cd99ea735ee",
"fkNewOrderItemRowId": "cef84490-8329-4c16-80d9-9933fdba1131",
"fkNewStockItemId": "26d57062-bc57-461b-a0e3-34783ceb506b",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2021-07-29T09:24:42.3802174+01:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "e68065ad-7ee6-4522-8bbb-d282870d919d",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2021-07-29T09:24:42.3802174+01:00"
}
]