Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Shop API documents 23.2

Promotion document (Shop API 23.2)

(supports custom properties)

Document representing a promotion.

Property Type Constraints Description
callout_msg Localized<String>   The localized call-out message of the promotion.
currency String   The currency that a promotion can be applied to. A null value means that the promotion applies to all allowed currencies.
details Localized<String>   The localized detailed description of the promotion.
discounted_products_link String   An optional product search link. Product promotions that are marked searchable provide a product search link with the promotion id as refinement.
end_date DateTime   The end date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ . The time zone of the date time is always UTC.
id String   The unique id of the promotion.
image String   The URL to the promotion image.
name Localized<String>   The localized name of the promotion.
start_date DateTime   The start date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The time zone of the date time is always UTC.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.