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).

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Orders
Learn more about app permissions.
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?