SalesRuleDataRuleInterface

May 18, 2017 ยท View on GitHub

Properties

NameTypeDescriptionNotes
ruleIdintRule id[optional]
namestringRule name[optional]
storeLabels\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleLabelInterface[]Display label[optional]
descriptionstringDescription[optional]
websiteIdsint[]A list of websites the rule applies to
customerGroupIdsint[]Ids of customer groups that the rule applies to
fromDatestringThe start date when the coupon is active[optional]
toDatestringThe end date when the coupon is active[optional]
usesPerCustomerintNumber of uses per customer
isActiveboolThe coupon is active
condition\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataConditionInterface[optional]
actionCondition\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataConditionInterface[optional]
stopRulesProcessingboolTo stop rule processing
isAdvancedboolIs this field needed
productIdsint[]Product ids[optional]
sortOrderintSort order
simpleActionstringSimple action of the rule[optional]
discountAmountfloatDiscount amount
discountQtyfloatMaximum qty discount is applied[optional]
discountStepintDiscount step
applyToShippingboolThe rule applies to shipping
timesUsedintHow many times the rule has been used
isRssboolWhether the rule is in RSS
couponTypestringCoupon type
useAutoGenerationboolTo auto generate coupon
usesPerCouponintLimit of uses per coupon
simpleFreeShippingstringTo grant free shipping[optional]
extensionAttributes\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleExtensionInterface[optional]

[Back to Model list] [Back to API list] [Back to README]