Home > @poq/sdk-sfcc > Promotion
Document representing a promotion.
Signature:
export declare class Promotion extends BaseModel<Promotion>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Promotion class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| calloutMsg? | string | (Optional) The localized call-out message of the promotion. | |
| currency? | string | (Optional) The currency that a promotion can be applied to. A null value means that the promotion applies to all allowed currencies. | |
| details? | string | (Optional) The localized detailed description of the promotion. | |
| discountedProductsLink? | string | (Optional) An optional product search link. Product promotions that are marked searchable provide a product search link with the promotion id as refinement. | |
| endDate? | string | (Optional) The end date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd’T’HH:mmZ . The time zone of the date time is always UTC. | |
| id? | string | (Optional) The unique id of the promotion. | |
| image? | string | (Optional) The URL to the promotion image. | |
| name? | string | (Optional) The localized name of the promotion. | |
| startDate? | string | (Optional) The start date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd’T’HH:mmZ. The time zone of the date time is always UTC. |