CouponDefinition.md

Bfwd::CouponDefinition

Properties

Name	Type	Description	Notes
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	String	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	DateTime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
id	String	{ "description" : "ID of the coupon-definition.", "verbs":["POST","PUT","GET"] }	[optional]
crm_id	String	{ "description" : "CRM ID of the product-rate-plan.", "verbs":["POST","PUT","GET"] }
organization_id	String	{ "description" : "ID of the organization associated with the coupon-definition.", "verbs":["POST","PUT","GET"] }
name	String	{ "description" : "The human readable name of the coupon-definition.", "verbs":["POST","PUT","GET"] }
description	String	{ "description" : "The human readable description of the coupon-definition.", "verbs":["POST","PUT","GET"] }
customer_code	String	{ "description" : "The customerCode associated with the organization.", "verbs":["POST","PUT","GET"] }
target	String	{ "description" : "The target of the coupon-definition. Currently coupon-definitions can only target products.", "verbs":["POST","PUT","GET"] }
currency	String	{ "description" : "The currency of the coupon-definition specified by a three character ISO 4217 currency code.", "verbs":["POST","PUT","GET"] }
definition_valid_from	DateTime	{ "description" : "The UTC DateTime that the coupon-definition is valid from.", "verbs":["POST","PUT","GET"] }
definition_valid_till	DateTime	{ "description" : "The UTC DateTime that the coupon-definition is valid until.", "verbs":["POST","PUT","GET"] }	[optional]
instance_duration_period	String	{ "description" : "instanceDurationPeriod", "verbs":["POST","PUT","GET"] }
instance_duration	Integer	{ "description" : "instanceDuration", "verbs":["POST","PUT","GET"] }
fixed_end_date	DateTime	{ "description" : "The UTC DateTime specifying the fixed end date of the coupon-definition.", "verbs":["POST","PUT","GET"] }	[optional]
state	String	{ "description" : "The current state of the coupon-definition.", "verbs":["POST","PUT","GET"] }
modifiers	Array<CouponModifierBase>	{ &quot;description&quot; : &quot;The collection of coupon-modifiers associated with the coupon-definition.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }
rules	Array<CouponRule>	{ &quot;description&quot; : &quot;The collection of coupon-rules associated with the coupon-definition.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }