POST

Get Order Refundability

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The following information is returned:

  • Whether a payment is refundable; previously refunded amounts; possible refund amounts for each payment.
  • Refundable and previously refunded quantities for each line item, as well as shipping and additional fees.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/order-billing/get-order-refundability
Body Params
orderIdstringRequiredformat GUID

Order ID.

Response Object
paymentsArray <PaymentRefundability>maxItems 100

Payments and their refundability amounts and statuses.

paymentsSummaryPaymentsSummary

Aggregated payments summary.

lineItemsArray <LineItemRefundability>maxItems 300

List of line item refund quantities.

shippingShipping

Shipping refund amounts - both previously refunded and the amount still available for refund.

additionalFeesArray <AdditionalFeeRefundability>maxItems 100

List of additional fee refund amounts - both previously refunded and the amount still available for refund.

Get Order Refundability

Get refundability for partially refunded order.

Request
cURL
Response
JSON
Errors

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

Did this help?