bulkUpdatePaymentStatuses( )

Developer Preview

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

Updates multiple order payments with a specified status.

The bulkUpdatePaymentStatus() function returns a Promise that resolves when the payment statuses are updated.

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.
Method Declaration
Copy
function bulkUpdatePaymentStatuses(
  paymentAndOrderIds: Array<PaymentAndOrderId>,
  options: BulkUpdatePaymentStatusesOptions,
): Promise<BulkUpdatePaymentStatusesResponse>;
Method Parameters
paymentAndOrderIdsArray<PaymentAndOrderId>Required

Order and payment IDs for which to update payment status.

optionsBulkUpdatePaymentStatusesOptions
Returns
Return Type:Promise<BulkUpdatePaymentStatusesResponse>
JavaScript
import { orderTransactions } from "@wix/ecom";

async function bulkUpdatePaymentStatuses(paymentAndOrderIds, options) {
  const response = await orderTransactions.bulkUpdatePaymentStatuses(
    paymentAndOrderIds,
    options,
  );
}
Errors

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

Did this help?