Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ProcessedOrders /GetTotalRefunds

Allows 150 calls per minute

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.)

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ProcessedOrders/GetTotalRefunds

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.

pkOrderId=b42149a6-3dc5-482c-8b3d-ff0f9092df20&includeBookings=true

Response

This is an example of the response JSON. Results will vary depending on your data.

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