Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ProcessedOrders

IsRefundValid

Use this call to determine if the refunds in a given return set are valid. <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/ProcessedOrders/IsRefundValid

Request body

pkOrderIdstring uuid

The id of the order to validate the refund with

Example request

{
  "pkOrderId": "00000000-0000-0000-0000-000000000000",
  "refundItems": [
    {
      "pkRefundRowId": "00000000-0000-0000-0000-000000000000",
      "fkOrderItemId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Response

OK

Type'Success' | 'Unknown' | 'RefundAutomationDisabled' | 'NotAllowedByChannel' | 'InvalidRefundAmounts' | 'NotImplementedForChannel'

Validation result

AdditionalInformationstring

Additional information

Example response

{
  "InvalidItems": [
    {
      "pkRefundRowId": "00000000-0000-0000-0000-000000000000",
      "fkOrderItemId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}