Promotion Object


A promotion is a visual banner displayed on store category pages, including their product gallery sections. Use promotions to highlight sales, seasonal offers, or featured content and link customers to relevant pages.

Properties
categoriesArray <CategoryAssignment>maxItems 1000

Categories the promotion is directly assigned to. A promotion may also appear in subcategories when appliedToSubcategories is true for a directly assigned category.


createdDatestringRead-onlyformat date-time

Date and time the promotion was created.


destinationUrlstringformat WEB_URL

URL the promotion redirects to when a customer clicks the banner.


enabledboolean

Whether the promotion is enabled.

When creating or updating with media.url, this value takes effect only after the media import completes successfully. See media.url for details.

Default: false


extendedFieldsExtendedFields

Custom field data for the promotion object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Promotion ID.


mediaPromotionMedia

Promotion media.


namestringminLength 1maxLength 50

Promotion name.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the promotion is updated. To prevent conflicting changes, the current revision must be passed when updating the promotion.


tagsTags

Tags for organizing and filtering promotions.


updatedDatestringRead-onlyformat date-time

Date and time the promotion was last updated.

Did this help?