Coupon

A coupon associated with a promotion.

Introduced in API version 52.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • The Coupon object is available if the B2B Commerce or Marketing license is enabled.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 68.0

  • Description:

    The business unit associated with the coupon.

    This field is a relationship field.

  • Relationship name: BusinessUnit

  • Relationship type: relationship

  • Refers to: BusinessUnit

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: Coupon code for the coupon. A buyer can use the coupon code to qualify for a promotion.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Introduced: API version 68.0
  • 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.
  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Description: Description of the coupon.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The end date and time when the coupon is no longer active.

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 68.0

  • 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.

  • Default value: false

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Name of the coupon.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • 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: relationship

  • Refers to: Promotion

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: Number of times this coupon can be used in total.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: Number of times this coupon can be used per customer.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The start date and time when the coupon is active.

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

  • Description:

    Status of the coupon.

    The default value is Inactive

  • Possible values:

    • Active — Active
    • Inactive — Inactive
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 68.0
  • 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:
    • Multi-Code — Multi-Code
    • Single-Code — Single-Code
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 68.0
  • Description: The value of the coupon. This field applies only to coupons of multi-code type.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.