| BusinessUnitId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The business unit associated with the coupon.
- This field is a relationship field.
- Relationship Name
- BusinessUnit
- Refers To
- BusinessUnit
|
| CouponCode |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- Coupon code for the coupon. A buyer can use the coupon code to
qualify for a promotion.
|
| CouponListName |
- Type
- string
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Display name of the coupon. It’s different from the auto-generated
system name and provides context for identifying the coupon's
campaign purpose. It applies only to multi-code coupons.
|
| CurrencyIsoCode |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable, Restricted
picklist, Sort, Update
- Description
- Available only for orgs with the multicurrency feature enabled.
Contains the ISO code for any currency allowed by the
organization.
|
| Description |
- Type
- textarea
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Description of the coupon.
|
| EndDateTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The end date and time when the coupon is no longer active.
|
| IsNewCodePerAssignment |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Indicates whether a new code is generated for each assignment.
This field applies only to coupons of multi-code type.
- The default value is false.
|
| LastReferencedDate |
- Type
- datetime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp when the current user last accessed this record, a
record related to this record, or a list view.
|
| LastViewedDate |
- Type
- datetime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp when the current user last viewed this record or
list view. If this value is null, the user might have only accessed
this record or list view (LastReferencedDate)
but not viewed it.
|
| Name |
- Type
- string
- Properties
- Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description
- Name of the coupon.
|
| OwnerId |
- Type
- reference
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- The ID of the owner of this coupon.
- This is a polymorphic relationship field.
- Relationship Name
- Owner
- Relationship Type
- Lookup
- Refers To
- Group, User
|
| PromotionId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- ID of the promotion associated with the coupon. Optional for
coupons of multi-code type.
- This is a relationship field.
- Relationship Name
- Promotion
- Relationship Type
- Lookup
- Refers To
- Promotion
|
| RedemptionLimitAllBuyers |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Number of times this coupon can be used in total. This field is
available in API version 61.0 and later.
|
| RedemptionLimitPerBuyer |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Number of times this coupon can be used per customer. This field
is available in API version 61.0 and later.
|
| StartDateTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The start date and time when the coupon is active.
|
| Status |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Restricted picklist,
Sort, Update
- Description
- Status of the coupon.
- Possible values are:
- The default value is Inactive
|
| Type |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort,
Update
- Description
- Specifies the type of coupon. Use Single-Code or leave the field
blank to create Commerce batch coupons with one shared code. Use
Multi-Code for marketing campaigns to distribute unique codes to
individual recipients. This field is available only when both
Commerce and Marketing licenses are enabled.
- Possible values are:
|
| Value |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The value of the coupon. This field applies only to coupons of
multi-code type.
|
j