This call is made when creating an RMA or refund request for orders from this channel. It allows you to determine what kinds of refunds and returns are supported on the channel, so that the UI is presented accordingly.
📘 POST
Field Name Type Description AuthorizationToken StringAuthorization Token from the customers integration.
Sample Request
{
"AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148"
}Field Name Type Description Error StringIf there was an error with the product update. CanCancel BooleanDetermines whether the channel allows cancelling an order. CanCancelOrderLines BooleanDetermines whether the channel allows cancelling individual order lines. CanCancelOrderLinesPartially BooleanDetermines whether the channel allows cancelling only part of an order line (not the full quantity). AutomaticRefundOnCancel BooleanDetermines whether the channel will automatically refund an order when it is cancelled. CanRefund BooleanDetermines whether the channel allows refunding an order. CanAttachRefundToItem BooleanDetermines whether the channel allows attaching refunds to a particular order line. CanAttachRefundToService BooleanDetermines whether the channel allows attaching refunds to service lines. RefundShippingTypes Required ShippingRefundTypeDetermines how the channel deals with shipping refunds. CanRefundAdditionally BooleanDetermines whether the channel allows creating refunds independent of any items/shipping. CanReturn BooleanDetermines whether the channel allows creating returns. PostSaleReasons Required PostSaleReasons[]Provides a list of reasons for post-sale actions.
Flag Numeric Value Description NotSupported 0Shipping refunds are not supported. TiedToItem 1Shipping refunds are only supported when attached to an item. Independent 2Shipping refunds are supported as independent refunds.
Field Name Type Description Tag Required StringValue used when submitting to the channel, e.g. OrderedWrongSize. DisplayName Required StringA user-readable version of Tag, displayed to the user, e.g. Ordered Wrong Size. Types Required ChannelReasonType[]The action this reason relates to, e.g. is this a reason for cancelling an order, or is it a reason for refunding shipping cost, or both etc. SubReasons SubReason[]Any subreasons for the reason.
Type Numeric Value Description Cancellation 0The reason is used when cancelling an order. ItemRefund 1The reason can be used as a reason for refunding an item. ShippingRefund 2The reason can be used as a reason for refunding the shipping cost. ServiceRefund 3The reason can be used as a reason for refunding a service item. AdditionalRefund 4The reason can be used for any additional refunds made.
Field Name Type Description Tag Required StringValue used when submitting to the channel. DisplayName Required StringA user-readable version of Tag, displayed to the user.
Sample Response
{
"Error": null,
"CanCancel": true,
"CanCancelOrderLines": true,
"CanCancelOrderLinesPartially": true,
"AutomaticRefundOnCancel": false,
"CanRefund": true,
"CanAttachRefundToItem": true,
"CanAttachRefundToService": false,
"RefundShippingTypes": 0,
"CanRefundAdditionally": false,
"CanReturn": false
}