EcommercePromoRules
Get information about a store's promo rules
Table Specific Information
Select
The add-in 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 add-in.
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 Store Id. |
| Id [KEY] | String | The ID of the associated promo rule. |
| Ttile | String | The title that will show up in promotion campaign. |
| Description | String | The description of a promotion restricted to UTF-8 characters with max length 255. |
| StartsAt | Datetime | The date and time when the promotion is in effect in ISO 8601 format. |
| EndsAt | Datetime | The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. |
| Amount | Decimal | The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive |
| Type | String | Type of discount. For free shipping set type to fixed.
The allowed values are fixed, percentage. |
| Target | String | The target that the discount applies to.
The allowed values are per_item, total, shipping. |
| Enabled | Boolean | Whether the promo rule is currently enabled. |
| CreatedAtForeign | Datetime | The date and time the promotion was created in ISO 8601 format. |
| UpdatedAtForeign | Datetime | The date and time the promotion was updated in ISO 8601 format. |
| Links | String | A list of link types and descriptions for the API schema documents. |