Skip to main content
Version: 5.7.0

Promotions

Promotions is a new service that allows devs to create/edit/delete promotions programmatically via S2S and cloud-code.

Important notes (when creating or updating a promotion):

  • Include only products that you want to CHANGE the price of in the "prices" section of the JSON
  • Products whose prices are to remain UNCHANGED should not be included in "prices"
  • Products to remove from availability should be encoded with a priceId of -2

API Summary

Promotions

  • SysGetPromotionList - Returns the list of configured promotions (without full details).
  • SysReadPromotion - Returns the full configuration data of the specified promotion.
  • SysCreatePromotion - Creates a new promotion. The full promotion JSON (minus the promotionId) should be provided. The full promotion JSON, including the created promotionId, will be returned as a result (similar to SysReadPromotion()).
  • SysUpdatePromotion - Updates the specified promotion with the provided promotionJson. Any promotionId included in the promotionJson will be ignored.
  • SysDeletePromotion - Deletes the specified promotion from the server.
  • SysEnablePromotion - Enable/Disable a promotion. A convenience API for easily toggling a promotion on/off.