listTransactionsForSingleOrder( )

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 information about payments and refunds associated with a specified order.

The listTransactionsForSingleOrder() function returns a Promise that resolves when the specified order's transaction records are retrieved.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function listTransactionsForSingleOrder(
  orderId: string,
): Promise<ListTransactionsForSingleOrderResponse>;
Method Parameters
orderIdstringRequired

Order ID.

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

async function listTransactionsForSingleOrder(orderId) {
  const response =
    await orderTransactions.listTransactionsForSingleOrder(orderId);
}
Errors

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

Did this help?