Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /CreateRefund

Response: CreateRefundResponse



Creates a refund in the system for approval

Parameters

NameTypeDescription
requestCreateRefundRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / CreateRefund

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.CreateRefundsNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/CreateRefund 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": "c64662a2-1c9b-4154-bad4-94626d3705d7",
  "RefundLines": [
    {
      "ReturnRowId": 1,
      "OrderItemRowId": "08c4c691-30ca-4afd-b29c-61690cabc2fd",
      "RefundedUnit": 0,
      "CancelledQuantity": 1,
      "IsFreeText": false,
      "FreeTextOrNote": "sample string 1",
      "Amount": 2.0,
      "Quantity": 3,
      "ReasonTag": "sample string 4",
      "SubReasonTag": "sample string 5",
      "InsufficientRefundTag": "sample string 6",
      "InsufficientRefundNote": "sample string 7"
    },
    {
      "ReturnRowId": 1,
      "OrderItemRowId": "08c4c691-30ca-4afd-b29c-61690cabc2fd",
      "RefundedUnit": 0,
      "CancelledQuantity": 1,
      "IsFreeText": false,
      "FreeTextOrNote": "sample string 1",
      "Amount": 2.0,
      "Quantity": 3,
      "ReasonTag": "sample string 4",
      "SubReasonTag": "sample string 5",
      "InsufficientRefundTag": "sample string 6",
      "InsufficientRefundNote": "sample string 7"
    }
  ]
}

Response

This is an example response. Results may vary depending on your data.

{
  "RefundHeaderId": 1,
  "RefundReference": "sample string 1",
  "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"
      ]
    }
  },
  "CannotRefundReason": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "RefundLines": [
    {
      "RefundRowId": "d3899ddf-f943-417e-9572-b0a2fb77a659",
      "RefundHeaderId": 2,
      "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"
          ]
        }
      },
      "RefundedUnit": 0,
      "IsShippingRefund": false,
      "IsAdditionalRefund": false,
      "RefundedItem": {
        "OrderItemRowId": "70cb2f3b-101b-4257-b6d8-9301d63039ad",
        "ReturnRowId": 1,
        "ItemSKU": "sample string 2",
        "ChannelSKU": "sample string 3",
        "ItemTitle": "sample string 4",
        "Cost": 5.0,
        "CancelledQuantity": 6
      },
      "ValidationError": "sample string 4",
      "Error": "sample string 4",
      "Errors": [
        {
          "RefundRowId": "ef665830-3875-491c-8af8-02044644fad5",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0366899+01:00",
          "Acknowledged": true
        },
        {
          "RefundRowId": "ef665830-3875-491c-8af8-02044644fad5",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0366899+01:00",
          "Acknowledged": true
        }
      ],
      "ExternalReference": "sample string 5",
      "Actioned": true,
      "ActionedDate": "2019-08-21T13:34:05.0366899+01:00",
      "ChannelInitiated": true,
      "Deleted": true,
      "IsFreeText": false,
      "FreeTextOrNote": "sample string 9",
      "Amount": 10.0,
      "Quantity": 11,
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "InsufficientRefundTag": "sample string 14",
      "InsufficientRefundNote": "sample string 15"
    },
    {
      "RefundRowId": "d3899ddf-f943-417e-9572-b0a2fb77a659",
      "RefundHeaderId": 2,
      "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"
          ]
        }
      },
      "RefundedUnit": 0,
      "IsShippingRefund": false,
      "IsAdditionalRefund": false,
      "RefundedItem": {
        "OrderItemRowId": "70cb2f3b-101b-4257-b6d8-9301d63039ad",
        "ReturnRowId": 1,
        "ItemSKU": "sample string 2",
        "ChannelSKU": "sample string 3",
        "ItemTitle": "sample string 4",
        "Cost": 5.0,
        "CancelledQuantity": 6
      },
      "ValidationError": "sample string 4",
      "Error": "sample string 4",
      "Errors": [
        {
          "RefundRowId": "ef665830-3875-491c-8af8-02044644fad5",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0366899+01:00",
          "Acknowledged": true
        },
        {
          "RefundRowId": "ef665830-3875-491c-8af8-02044644fad5",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0366899+01:00",
          "Acknowledged": true
        }
      ],
      "ExternalReference": "sample string 5",
      "Actioned": true,
      "ActionedDate": "2019-08-21T13:34:05.0366899+01:00",
      "ChannelInitiated": true,
      "Deleted": true,
      "IsFreeText": false,
      "FreeTextOrNote": "sample string 9",
      "Amount": 10.0,
      "Quantity": 11,
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "InsufficientRefundTag": "sample string 14",
      "InsufficientRefundNote": "sample string 15"
    }
  ]
}