getCoupon( )

Retrieves a coupon by ID.

The getCoupon() function returns a Promise that resolves when the specified coupon is retrieved.

Authentication

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

Permissions
Manage Coupons
Manage Stores - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

ID of the coupon to retrieve.

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