Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ReturnsRefunds /CreateRefund

Allows 150 calls per minute

Response: CreateRefundResponse



Creates a refund in the system for approval

Parameters

NameTypeDescription
requestCreateRefundRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.CreateRefundsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ReturnsRefunds/CreateRefund

Headers

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

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "ChannelInitiated": true,
  "OrderId": "59db1e9b-eaf5-413f-af3a-dbdc905b7968",
  "RefundLines": [
    {
      "ReturnRowId": 1,
      "OrderItemRowId": "53e26365-6a11-4166-b8fb-9a9e6a357970",
      "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 of the response JSON. Results will 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"
      ]
    }
  },
  "CannotRefundReason": 0,
  "Errors": [
    "sample string 1"
  ],
  "RefundLines": null
}