| 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.
GET | 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=50d36023-e6aa-4f03-9ca4-06f18d603c9e&exchangeItems=[
{
"OrderItemRowId": "10cb33c5-61d4-4851-8aef-ee6bdb22fc17",
"OrderItemBatchId": 1,
"Refund": 2.1,
"Qty": 3,
"ScrapQty": 1,
"Batch": {
"OrderItemBatchId": 1,
"OrderItemRowId": "e6faeb8b-e6e0-4376-931a-2de9be16349b",
"BatchInventoryId": 3,
"Quantity": 4,
"Batch": {
"BatchId": 1,
"SKU": "sample string 2",
"InventoryTrackingType": 3,
"StockItemId": "868768d7-f76a-40ca-81f5-b671dfd066e4",
"BatchNumber": "sample string 5",
"ExpiresOn": "2022-09-05T15:10:00.946451+03:00",
"SellBy": "2022-09-05T15:10:00.946451+03:00",
"Inventory": [
{
"BatchInventoryId": 1,
"BatchId": 2,
"StockLocationId": "1cc915e0-09be-4821-93f6-038b16c1fd0d",
"BinRack": "sample string 4",
"PrioritySequence": 5,
"Quantity": 6,
"StockValue": 7.0,
"StartQuantity": 8,
"PickedQuantity": 9,
"BatchStatus": "Available",
"IsDeleted": true,
"WarehouseBinrackStandardType": 1,
"WarehouseBinrackTypeName": "sample string 12",
"InTransfer": 1,
"BinRackId": 1,
"WarehouseBinrackTypeId": 1
}
],
"IsDeleted": true
},
"DespatchUnitValue": 0.0,
"AssignmentType": 0
},
"AdditionalCost": 4.1,
"NewStockItemId": "8acec39e-3ceb-4986-b31a-b92d652e49d7",
"NewQty": 5
}
]&despatchLocation=b2938e17-d1df-440b-9e5a-add8db488555&returnLocation=3841f8d1-64b8-4e83-94ec-e3d551df82d2&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": "c4cf80aa-8a00-4343-90ad-d95e5e3baf5f",
"fkOrderItemRowId": "c1080163-fbc8-4535-b72c-b7f5f3ba6325",
"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": "72b2caf2-435b-4166-a856-f08b6196c2ec",
"Scrapped": true,
"ScrapQty": 1,
"LastState": "sample string 16",
"LastDate": "2022-09-05T15:10:04.3550076+03:00",
"Completed": true,
"fkNewOrderId": "44a3734b-5638-44e4-bf6d-26f29d47f361",
"fkNewOrderItemRowId": "d6853d0a-dad0-4fe5-abb5-b923a6f73cc5",
"fkNewStockItemId": "bc588f75-2e29-4d3f-a16e-b8a72106299e",
"NewQty": 1,
"NewOrderId": 1,
"NewOrderCancelled": true,
"NewSKU": "sample string 20",
"NewItemTitle": "sample string 21",
"NewOrderProcessedOn": "2022-09-05T15:10:04.3550076+03:00",
"AdditionalCost": 1.1,
"fkRefundRowId": "1b6a1497-0c80-4367-a808-1850ae5dfa8b",
"RefundedAmount": 1.1,
"PendingRefund": 1.1,
"ReturnDate": "2022-09-05T15:10:04.3550076+03:00"
}
]