Promotion Enhancements

Introducing new enhancements to increase flexibility of OrderCloud Promotions.

New Properties

• AutoApply, default false

  • This new property enables customers to designate promotions as AutoApply, and set varying numeric Priority values which dictate the order in which promotions are automatically applied.

• Active, default true

  • Promotions where Active = false will not be evaluated for either the .../applypromotions or .../eligiblepromotions endpoints, and will never be returned from v1/me/promotions. Designating a promotion Active = false prevents a buyer user from accessing the promotion, without deleting the record from your marketplace.

  • A newly deactivated promotion will also be removed from any Unsubmitted orders immediately following deactivation. The promotion data will remain accessible from the administrative endpoints, making for a good historical record, or for possible reactivation in the future.

• Priority, nullable

  • The new Priority property on Promotions can be used to control the order in which promotions are applied when calling applypromotions or refreshpromotions endpoints, There are no rules around the sequencing of Priority values.

New Endpoints

• v1/orders/{direction}/{orderID}/eligiblepromotions and v1/cart/eligiblepromotions

  • The new endpoints enable listing eligible promotions for an order. This capability can support features such as displaying eligible promo codes to the buyer user during checkout, and many other UI driven promotion-based enhancements

• v1/orders/{direction}/{orderID}/refreshpromotions and v1/cart/refreshpromotions

  • Any eligible promotions designated as AutoApply will be applied to the order

    • They are sorted by Priority and applied them to the order one by one

    • Promotions where Priority = null will be evaluated last

    • The maximum number of promotions that will be applied to an order in a single API call is 100

  • Any promotions already applied to the order that are no longer eligible will be removed

    • Additionally, If calling refreshpromotions and there is a newly eligible promotion where AutoApply = true and CanCombine = false, any existing promotions with a lower priority will be removed, even if they are still eligible.

  • Any promotions already applied to the order will have their discounts recalculated

  • The response body contains an array of PromosAdded and PromosRemoved

• v1/orders/{direction}/{orderID}/applypromotions and v1/cart/applypromotions

  • Any eligible promotions designated as AutoApply will be applied to the order

    • They are sorted by Priority and applied them to the order one by one

    • Promotions where Priority = null will be evaluated last

    • The maximum number of promotions that will be applied to an order in a single API call is 100

    • The response body is the full Order object

Still have questions?
Ask in our Community Channel

Content Powered By