Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /IsRefundValid

Allows 150 calls per minute

Response: ValidationResult



Use this call to determine if the refunds in a given return set are valid.

Parameters

NameTypeDescription
pkOrderIdGuidThe id of the order to validate the refund with
refundItemsList<RefundItem>The refund rows

Example Request

The following request format is required for this method.

Endpoint URL

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

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=b4c2e805-0573-42cb-beb8-e850965bec9c&refundItems=[
  {
    "pkRefundRowId": "1f9105ec-76f5-449e-b5da-bd1f29b11329",
    "IsManualRefund": true,
    "Type": 1,
    "fkOrderItemId": "d22147f8-f1ca-4040-877d-4ffc4d6433d0",
    "RefundQty": 2,
    "RefundAmount": 3.1,
    "Reason": "sample string 4",
    "ChannelReason": "sample string 5",
    "ChannelReasonSec": "sample string 6"
  }
]

Response

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

{
  "Type": 1,
  "AdditionalInformation": "sample string 1"
}