Product add helpers
Helpers for dispatching events that add products to a quote, either immediately or within a specific interval.
addProducts(productIds, options?)
Signature:
addProducts(
productIds: string | string[],
options?: {
quantity?: number,
effectiveDate?: string,
effectiveDateOverride?: string
}
): CustomEvent
Parameter | Type | Required | Description |
|---|---|---|---|
| productIds | string | string[] | Yes | One product rate plan id or an array of ids. |
| options.quantity | number | No | Only used when productIds is a single id. Repeats the id quantity times. |
| options.effectiveDate | string | No | Explicit effective date. |
| options.effectiveDateOverride | string | No | Alternate effective date input. |
Returns:
CustomEvent('addproducts') with detail { prodIds, effectiveDate }
Example:
this.dispatchEvent(
zqf.addProducts(['a0hEi00000CRApNIAX', 'a0hEi00000CRApKIAX'], {
effectiveDate: '2026-07-13'
})
);
addProductsInInterval(intervalId, productIds, options?)
Signature:
addProductsInInterval(
intervalId: number | string | object,
productIds: string | string[],
options?: {
quantity?: number,
effectiveDate?: string,
effectiveDateOverride?: string
}
): CustomEvent
Parameter | Type | Required | Description |
|---|---|---|---|
| intervalId | number | string | object | Yes | Interval index, interval start date, or interval object. |
| productIds | string | string[] | Yes | One or more product rate plan ids. |
| options.quantity | number | No | Only used when productIds is a single id. |
| options.effectiveDate | string | No | Explicit effective date. |
| options.effectiveDateOverride | string | No | Alternate effective date input. |
Example:
this.dispatchEvent(
zqf.addProductsInInterval(1, ['a0hEi00000CRApNIAX'], {
effectiveDate: '2026-07-13'
})
);