EcommercePromoCodes
Retrieves the list of promo codes under a promo rule
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 and PromoRuleId can be retrieved by selecting the PromoRules view.
- StoreId supports the '=' operator.
- PromoRuleId supports the '=' operator.
- Id supports the '=' operator.
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';
Columns
| Name | Type | Description |
| StoreId [KEY] | String | The id for 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 | Number of times the code has been used. |
| 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. |