GuidesAPI ReferenceChangelog
HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Changelog
Back to All

Revel 2.72 API Updates

about 3 years ago by Zain Zaigham

Welcome to the 2.72 Revel API changelog!

In Revel 2.72, we've made important updates to our WebOrders resource. In particular, we added a new linked combo functionality that allows a group (or group) of products to be sold with the 'base' product.

Additionally, we have modified the /specialresources/cart/calculate, /specialresources/cart/submit, and specialresources/cart/validate endpoints underneath the WebOrders resource to allow modifiers options (no, lite, side, only) to be applied to an item within an order.

Please review the changes below in order to test and update your integration accordingly. Select version 'v2021.10.0' to see changes in the API reference section.

You can learn more about the general 2.72 release here.

Added Resources

  • The ProductUpcharge resource has been added to allow an API consumer to retrieve information about linked combos attached to a product.

Added a new endpoint /weborders/product_upcharge/

Query Params:
        product:
              type: int32
              description: ID of a product

Modified Resources

  • We've modified the /specialresources/cart/calculate,/specialresources/cart/submit, and specialresources/cart/validate endpoints underneath the WebOrders resource.

(1) Added a parameter to the modifieritems array located inside of the items array to allow modifiers options (reg, no, lite, side, only) to be applied to an item within an order: 

mod_type:
     type: number
     format: integer
     description: Modifier options type
     ### Modifier options types:
        * 0 - REGULAR [the default value -- no special option applied]
        * 1 - NO [modifier not being requested for the product]
        * 2 - SIDE [modifier requested to be on the side for the product]
        * 3 - ONLY [only include this modifier for the product]
        * 4 - LITE [modifier requested for the product but keep it light]

(2) Added linked combo support by adding the has_upsell field and product_sets array located inside of the items array:

has_upsell:
        type: boolean
        description: Flag if combo has upsell or not. If yes - we use it in total price.
        values: true/false

product_sets:
        type: array of objects
        Fields:
            id: 
               type: float
               description: Unique identifier of linked combo product group
            name: 
               type: String
               description: Name of linked combo product group
            products: 
                type: array of product objects

Planned Deprecation

  • We're continuing deprecation of the OrderAllInOne resource. This resource is no longer available for new third-party integrations. If you are still using it, please reach out to [email protected] for information on more suitable alternatives.