EcommercePromoCodes
Returns the list of promo codes under a promo rule.
View-Specific Information
Select
The provider uses the Mailchimp API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the provider.
| Column | Supported Operators |
| StoreId | = |
| PromoRuleId | = |
| Id | = |
For example, the following queries are processed server-side:
SELECT * FROM EcommercePromoCodes
SELECT * FROM EcommercePromoCodes WHERE Id = 'test_promorule2'
SELECT * FROM EcommercePromoCodes WHERE PromoRuleId = 'test_promorule2' AND StoreId = 'YM_Store'
SELECT * FROM EcommercePromoCodes WHERE PromoRuleId = 'test_promorule2' AND StoreId = 'YM_Store' AND Id = 'test_promorule2'
Note: To retrieve the StoreId, query the EcommerceStores view. To retrieve the PromoRuleId, query the PromoRules view.
Columns
| Name | Type | References | Description |
| StoreId [KEY] | String | The Id of the store. | |
| PromoRuleId [KEY] | String | The Id of the associated promo rule. | |
| Id [KEY] | String | The unique identifier of the promo code. | |
| Code | String | The actual promotional code. | |
| RedemptionUrl | String | URL used to redeem the promo code. | |
| UsageCount | Integer | Number of times the code has been used. | |
| Enabled | Boolean | Indicates whether the promo code 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. |