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
function getCoupon(_id: string): Promise<Coupon>;
Method Parameters
_idstringRequired

ID of the coupon to retrieve.

Returns
Return Type:Promise<Coupon>
JavaScript
import { coupons } from "wix-marketing.v2"; async function getCoupon(id) { try { const result = await coupons.getCoupon(id); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

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

Did this help?