Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ProcessedOrders

RefundServices

Use this call to refund one or more services on an order. Please check that any automated refunds are valid prior to calling this method. <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/RefundServices

Request body

pkOrderIdstring uuid

The id of the order to refund services for.

Example request

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

Response

OK

pkRefundRowIdstring uuid

Refund record ID

SKUstring

Product SKU

ItemTitlestring

Product title

IsItemboolean

If its an item that is refunded

IsServiceboolean

If its a service that is refunded

Amountnumber double

Refund amount

Reasonstring

Reason for a refund

Actionedboolean

If refund has been actioned

ActionDatestring date-time

When refund was actioned

ReturnReferencestring

return reference number

Costnumber double

Cost

RefundStatus'OPEN' | 'PROCESSED' | 'ERROR' | 'ERROR_ACKED' | 'PENDING'
IgnoredValidationboolean

Status of refund

fkOrderItemRowIdstring uuid

Order item record ID

ShouldSerializeChannelReasonboolean
ChannelReasonstring

Channel refund reason

ShouldSerializeChannelReasonSecboolean
ChannelReasonSecstring

Secondary channel reason for a refund

IsNewboolean

Example response

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