Creates an RMA booking in the system
Name | Type | Description |
---|---|---|
request | CreateRMABookingRequest | The request class for this call |
The following request format is required for this method.
POST https://eu-ext.linnworks.net/api/ReturnsRefunds/CreateRMABooking
Connection: 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.
request={
"ChannelInitiated": true,
"OrderId": "6c64e0c8-5e13-4225-a69b-db4b61c79480",
"ReturnItems": [
{
"OrderItemRowId": "4b1d83f5-5018-4c90-9863-6ed7cd3a6944",
"ReturnItemSKU": "sample string 2",
"ReturnItemTitle": "sample string 3",
"BatchInventoryId": 1,
"ReturnLocation": "801771b6-9737-4290-9690-c34ecb9c26f7",
"ReturnQuantity": 5,
"RefundAmount": 6.0,
"RefundRowId": "d3adf320-714b-4011-9151-9321fe35f326",
"ScrapQuantity": 7,
"ReasonCategory": "sample string 8",
"IsFreeText": false,
"Reason": "sample string 9",
"ReasonTag": "sample string 10",
"SubReasonTag": "sample string 11",
"BinrackOverride": "sample string 12"
}
],
"ExchangeItems": [
{
"ExchangeStockItemId": "b3b6a656-5fa4-412f-bb92-84e24a321caa",
"ExchangeSKU": "sample string 2",
"ExchangeTitle": "sample string 3",
"ExchangeQuantity": 4,
"DespatchLocationId": "a418b6d3-e28f-413e-a9d3-c52b6a8fe03f",
"AdditionalCost": 6.0,
"OrderItemRowId": "df67143a-ebd8-4672-b1d3-f129e7074ac5",
"ReturnItemSKU": "sample string 8",
"ReturnItemTitle": "sample string 9",
"BatchInventoryId": 1,
"ReturnLocation": "5c5235d1-95d1-4b19-aa70-8ef2f83334f7",
"ReturnQuantity": 11,
"RefundAmount": 12.0,
"RefundRowId": "0dd7a072-0375-439c-9671-7f972178ccbc",
"ScrapQuantity": 13,
"ReasonCategory": "sample string 14",
"IsFreeText": false,
"Reason": "sample string 15",
"ReasonTag": "sample string 16",
"SubReasonTag": "sample string 17",
"BinrackOverride": "sample string 18"
}
],
"ResendItems": [
{
"ResendQuantity": 1,
"DespatchLocationId": "cc57d20c-cae4-4d11-846b-442295d1a5fd",
"AdditionalCost": 3.0,
"OrderItemRowId": "e60bd479-0061-4281-bc64-a222b153f2ee",
"ReturnItemSKU": "sample string 5",
"ReturnItemTitle": "sample string 6",
"BatchInventoryId": 1,
"ReturnLocation": "5414ac37-0531-4c7e-a2bb-93a8cc77929c",
"ReturnQuantity": 8,
"RefundAmount": 9.0,
"RefundRowId": "a57bd702-a566-4327-ab88-4a05e4d660da",
"ScrapQuantity": 10,
"ReasonCategory": "sample string 11",
"IsFreeText": false,
"Reason": "sample string 12",
"ReasonTag": "sample string 13",
"SubReasonTag": "sample string 14",
"BinrackOverride": "sample string 15"
}
],
"Reference": "sample string 3"
}
This is an example of the response JSON. Results will vary depending on your data.
{
"RMAHeaderId": 1,
"Items": [
{
"RMARowId": 1,
"RMAHeaderId": 2,
"Type": 0,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1"
]
}
},
"ExternalReference": "sample string 3",
"CreatedDate": "2023-01-10T13:49:46.8199775+00:00",
"Actioned": true,
"ActionedDate": "2023-01-10T13:49:46.8199775+00:00",
"Deleted": true,
"ResendQuantity": 7,
"NewOrderId": "ef2f486d-1c3b-496f-8a88-03808e10df92",
"ValidationError": "sample string 10",
"Error": "sample string 10",
"Errors": [
{
"RMARowId": 1,
"ErrorMessage": "sample string 2",
"DateStamp": "2023-01-10T13:49:46.8199775+00:00",
"Acknowledged": true
}
],
"Info": "sample string 11",
"ExchangeStockItemId": "5968cc13-3605-4631-b109-e4d0db28cd96",
"ExchangeSKU": "sample string 13",
"ExchangeTitle": "sample string 14",
"ExchangeQuantity": 15,
"DespatchLocationId": "8063c708-2c3c-46ae-bc65-dac1f50f8bfe",
"AdditionalCost": 17.0,
"OrderItemRowId": "681c5204-35d7-4452-b87a-e5d9757550f7",
"ReturnItemSKU": "sample string 19",
"ReturnItemTitle": "sample string 20",
"BatchInventoryId": 1,
"ReturnLocation": "a36290c8-8449-4874-8189-ea560f797ebf",
"ReturnQuantity": 22,
"RefundAmount": 23.0,
"RefundRowId": "82f35ee6-6a1d-4a27-9190-f356f3820872",
"ScrapQuantity": 24,
"ReasonCategory": "sample string 25",
"IsFreeText": false,
"Reason": "sample string 26",
"ReasonTag": "sample string 27",
"SubReasonTag": "sample string 28",
"BinrackOverride": "sample string 29"
}
],
"Errors": [
"sample string 1"
],
"Info": [
"sample string 1"
]
}