getOrderRefundability( )

Retrieves refund information about an order's payments, line items, shipping, and additional fees.

Returns detailed refundability status for each payment:

  • refundable: Automatic refund is available.
  • manuallyRefundable: Refund is expected to be processed externally. Can be manually marked as refunded.
  • nonRefundable: Refund cannot be performed.

Use this method before processing refunds to understand what can be refunded and through which method (automatic vs manual).

Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

Returns
Return Type:Promise<GetOrderRefundabilityResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?