Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /CreateRMABooking

Response: CreateRMABookingResponse



Creates an RMA booking in the system

Parameters

NameTypeDescription
requestCreateRMABookingRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / CreateRMABooking

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.CreateReturnsExchangesNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/CreateRMABooking 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

request={
  "ChannelInitiated": true,
  "OrderId": "be9c415b-d2b3-4c54-b774-c52277fc762c",
  "ReturnItems": [
    {
      "OrderItemRowId": "1b593075-4989-4346-af13-bf5c64cb1740",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "471fa38a-327e-47aa-9d7c-46e4d3876c3d",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "a69addd0-786a-4bac-9a44-bf5943396029",
      "ScrapQuantity": 7,
      "ReasonCategory": "sample string 8",
      "IsFreeText": true,
      "Reason": "sample string 9",
      "ReasonTag": "sample string 10",
      "SubReasonTag": "sample string 11",
      "BinrackOverride": "sample string 12"
    },
    {
      "OrderItemRowId": "1b593075-4989-4346-af13-bf5c64cb1740",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "471fa38a-327e-47aa-9d7c-46e4d3876c3d",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "a69addd0-786a-4bac-9a44-bf5943396029",
      "ScrapQuantity": 7,
      "ReasonCategory": "sample string 8",
      "IsFreeText": true,
      "Reason": "sample string 9",
      "ReasonTag": "sample string 10",
      "SubReasonTag": "sample string 11",
      "BinrackOverride": "sample string 12"
    }
  ],
  "ExchangeItems": [
    {
      "ExchangeStockItemId": "329354f8-b31c-4077-b0d6-87edba63f387",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "cff8870d-e2ee-47d7-b67e-cdc904810e42",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "c5dd94af-9bbd-4037-a332-2fa44b08233f",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "f74f1e1f-e4db-4158-9596-9caa0342569a",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "e8bfda5e-4987-4c5f-91c5-cb1d87f75ee2",
      "ScrapQuantity": 13,
      "ReasonCategory": "sample string 14",
      "IsFreeText": true,
      "Reason": "sample string 15",
      "ReasonTag": "sample string 16",
      "SubReasonTag": "sample string 17",
      "BinrackOverride": "sample string 18"
    },
    {
      "ExchangeStockItemId": "329354f8-b31c-4077-b0d6-87edba63f387",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "cff8870d-e2ee-47d7-b67e-cdc904810e42",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "c5dd94af-9bbd-4037-a332-2fa44b08233f",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "f74f1e1f-e4db-4158-9596-9caa0342569a",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "e8bfda5e-4987-4c5f-91c5-cb1d87f75ee2",
      "ScrapQuantity": 13,
      "ReasonCategory": "sample string 14",
      "IsFreeText": true,
      "Reason": "sample string 15",
      "ReasonTag": "sample string 16",
      "SubReasonTag": "sample string 17",
      "BinrackOverride": "sample string 18"
    }
  ],
  "ResendItems": [
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "2612b95a-eabe-48fd-94d0-df96ad1b076f",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "ce54867f-de76-4fcb-bfa0-064df4307365",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "d0486848-4ef4-433c-9ac8-86848d443582",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "3e53860e-d8b2-42d9-b583-01b95934d477",
      "ScrapQuantity": 10,
      "ReasonCategory": "sample string 11",
      "IsFreeText": true,
      "Reason": "sample string 12",
      "ReasonTag": "sample string 13",
      "SubReasonTag": "sample string 14",
      "BinrackOverride": "sample string 15"
    },
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "2612b95a-eabe-48fd-94d0-df96ad1b076f",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "ce54867f-de76-4fcb-bfa0-064df4307365",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "d0486848-4ef4-433c-9ac8-86848d443582",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "3e53860e-d8b2-42d9-b583-01b95934d477",
      "ScrapQuantity": 10,
      "ReasonCategory": "sample string 11",
      "IsFreeText": true,
      "Reason": "sample string 12",
      "ReasonTag": "sample string 13",
      "SubReasonTag": "sample string 14",
      "BinrackOverride": "sample string 15"
    }
  ]
}

Response

This is an example response. Results may 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",
            "sample string 2"
          ]
        }
      },
      "ExternalReference": "sample string 3",
      "CreatedDate": "2019-06-12T09:27:51.421207+01:00",
      "Actioned": true,
      "ActionedDate": "2019-06-12T09:27:51.421207+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "06fd0224-ae64-4176-9b03-1b0388939f52",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.421207+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.421207+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "3573d975-fcd3-425a-a361-8806a4aef586",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "736d79ee-0500-4951-a7fd-c58104976a2a",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "90bc750a-9086-48f6-8d37-f441da2d352b",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "26694f0b-d2e3-4883-882e-a646d8789434",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "3d440f05-cda3-4467-bceb-21b5a9bd429a",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": true,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    },
    {
      "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",
            "sample string 2"
          ]
        }
      },
      "ExternalReference": "sample string 3",
      "CreatedDate": "2019-06-12T09:27:51.421207+01:00",
      "Actioned": true,
      "ActionedDate": "2019-06-12T09:27:51.421207+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "06fd0224-ae64-4176-9b03-1b0388939f52",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.421207+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.421207+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "3573d975-fcd3-425a-a361-8806a4aef586",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "736d79ee-0500-4951-a7fd-c58104976a2a",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "90bc750a-9086-48f6-8d37-f441da2d352b",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "26694f0b-d2e3-4883-882e-a646d8789434",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "3d440f05-cda3-4467-bceb-21b5a9bd429a",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": true,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Info": [
    "sample string 1",
    "sample string 2"
  ]
}