Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /GetTotalRefunds

Response: ExistingRefundTotal



Use this call to retrieve the total value of refunds against an order.

Parameters

NameTypeDescription
pkOrderIdGuidThe id of the order
includeBookingsNullable<Boolean>If true, pending refunds against return bookings and exchange bookings will be included. (Optional, default is false.)

HTTP Endpoint

Server /ProcessedOrders / GetTotalRefunds

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ProcessedOrders/GetTotalRefunds 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=9f6395a4-0e2f-4a31-a9b4-8997b42aa6aa&includeBookings=true

Response

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

{
  "Amount": 1.1,
  "TotalCharge": 2.1,
  "Refundable": 1.0
}