Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /RefundCompleteOrder

Response: List<RefundInfo>



Use this call to refund the entire order. You may only call this method if the order does not currently have any refunds associated with it.

Parameters

NameTypeDescription
pkOrderIdGuidThe id of the order to perform a complete refund for.
isManualRefundBooleanIf true, the refund will need to be manually actioned. If false (and channel refunds are available), it will automatically be actioned.

HTTP Endpoint

Server /ProcessedOrders / RefundCompleteOrder

Permissions


Example Code

Example Request

The following request format is required for this method.

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

pkOrderId=f4b9f9a8-3046-4c16-978d-d8654d43f93e&isManualRefund=true

Response

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

[
  {
    "pkRefundRowId": "a69fc365-59a0-48f1-b843-17d7927c4474",
    "SKU": "sample string 1",
    "ItemTitle": "sample string 2",
    "IsItem": true,
    "IsService": true,
    "Amount": 5.1,
    "Reason": "sample string 6",
    "Actioned": true,
    "ActionDate": "2018-02-19T16:57:07.7772564+00:00",
    "ReturnReference": "sample string 8",
    "Cost": 1.1,
    "RefundStatus": 0,
    "IgnoredValidation": true,
    "fkOrderItemRowId": "9dd6d92d-af64-4d49-a8ee-281664c50fa2",
    "ShouldSerializeChannelReason": false,
    "ChannelReason": "sample string 10",
    "ShouldSerializeChannelReasonSec": false,
    "ChannelReasonSec": "sample string 11"
  },
  {
    "pkRefundRowId": "a69fc365-59a0-48f1-b843-17d7927c4474",
    "SKU": "sample string 1",
    "ItemTitle": "sample string 2",
    "IsItem": true,
    "IsService": true,
    "Amount": 5.1,
    "Reason": "sample string 6",
    "Actioned": true,
    "ActionDate": "2018-02-19T16:57:07.7772564+00:00",
    "ReturnReference": "sample string 8",
    "Cost": 1.1,
    "RefundStatus": 0,
    "IgnoredValidation": true,
    "fkOrderItemRowId": "9dd6d92d-af64-4d49-a8ee-281664c50fa2",
    "ShouldSerializeChannelReason": false,
    "ChannelReason": "sample string 10",
    "ShouldSerializeChannelReasonSec": false,
    "ChannelReasonSec": "sample string 11"
  }
]