EcommercePromoRules
Returns details about promotional rules configured for a store, including eligibility and discount types.
Table Specific Information
Select
The connector will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the connector.
The StoreId can be retrieved by selecting the EcommerceStores view.
- StoreId supports the '=' operator.
- Id supports the '=' operator.
SELECT * FROM EcommercePromoRules; SELECT * FROM EcommercePromoRules where where Id='ruleid1' SELECT * FROM EcommercePromoRules where Id='ruleid1' and storeId='STR002';
Columns
| Name | Type | Description |
| StoreId [KEY] | String | The unique identifier of the store where the promotional rule is defined. Each store represents an e-commerce integration connected to the Mailchimp account. |
| Id [KEY] | String | The unique identifier assigned to the promotional rule within the store system. |
| Ttile | String | The display title of the promotion as it appears in campaigns or store interfaces. |
| Description | String | A brief description of the promotion, limited to 255 UTF-8 characters, summarizing its purpose or eligibility criteria. |
| StartsAt | Datetime | The date and time when the promotion becomes active, recorded in ISO 8601 format. |
| EndsAt | Datetime | The date and time when the promotion expires, recorded in ISO 8601 format. This must occur after the start date. |
| Amount | Decimal | The value of the promotional discount. If the 'Type' is 'fixed', this amount represents a monetary value. If 'Type' is 'percentage', it must be a decimal between 0.0 and 1.0 inclusive. |
| Type | String | The discount type applied by the promotion, such as 'fixed' for a set monetary discount, 'percentage' for proportional savings, or 'free_shipping' for shipping-related offers.
The allowed values are fixed, percentage. |
| Target | String | The entity or category the discount applies to, such as specific products, collections, or entire orders.
The allowed values are per_item, total, shipping. |
| Enabled | Boolean | If the value is 'true', the promotional rule is active and can be applied to orders. If the value is 'false', it is inactive or expired. |
| CreatedAtForeign | Datetime | The date and time when the promotional rule was created in the store, recorded in ISO 8601 format. |
| UpdatedAtForeign | Datetime | The date and time when the promotional rule was last updated in the store, recorded in ISO 8601 format. |
| Links | String | A list of related API schema references and navigation links associated with the promotional rule resource. |