managementGetOrder( )

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 an order by ID.

The managementGetOrder() function returns a Promise that resolves to information about the specified order.

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 Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Method Declaration
Method Parameters

Order ID.


Options to use when getting an order.

Return Type:Promise<GetOrderResponse>
Was this helpful?