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.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

Returns
Return Type:Promise<ListTransactionsForSingleOrderResponse>
Was this helpful?
Yes
No