Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

id

String

The ID of the retrieved promotion campaign

nameStringThe name of the retrieved promotion campaign
alternative_codeStringThe alternative code of the retrieved promotion campaign
descriptionStringThe description of the retrieved promotion campaign
long_descriptionStringThe long description of the retrieved promotion campaign
short_descriptionStringThe short description of the retrieved promotion campaign
life_cycle_stateString

The life cycle state of the retrieved promotion campaign. Available options are:

  • DRAFT
  • POSTED
typeString

The type of the retrieved promotion campaign. Available options are:

  • DISCOUNT_PROMOTION
  • REWARD_PROMOTION
distribution_methodString

The distribution method of the retrieved promotion campaign. Available options are:

  • INSTANT
  • UPON_REQUEST
applicable_on_new_subscribersubscribersBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be redeemed used during creating a new subscribersubscribers
applicable_on_existing_subscribersubscribersBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be redeemed on an existing subscriber used on an existing subscribers
applicable_on_purchase_customer_eventsBoolean

Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on a purchase customer event

Tip

Available from CRM.COM R15.0.0

applicable_on_referral_customer_eventsBoolean

Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on a referral customer event

Tip

Available from CRM.COM R15.0.0

applicable_on_achievement_customer_eventsBoolean

Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on an achievement customer event

Tip

Available from CRM.COM R15.0.0

additive_discount_definitionAdditive Discount Definition ObjectThe Ad Hoc Discount Definition related to the retrieved promotion campaign

log_information

Log Information Object

The log information related with the retrieved promotion campaign

...

Anchor
promotion campaign referred objects
promotion campaign referred objects
Referred Objects Response Data

...

Include Page
log_information_short
log_information_short