getCoupon( )

Retrieves a coupon by ID.

The getCoupon() function returns a Promise that resolves when the specified coupon is 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 Coupons
Manage Stores - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

ID of the coupon to retrieve.

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