Revel 2.55 API Updates

Welcome to the 2.55 Revel API changelog!

In Version 2.55, we’ve introduced API endpoints related to our new Stocktake functionality. Please note these endpoints are currently in beta and will be refined in future releases.

We've also made important updates related to the OrderItem, Product and Modifier resources (for use with combo sets), as well as changes in ProductModifier resources. Please review these updates and update your applications accordingly.

You can learn more about the general 2.55 release here.

Added Resources

We've introduced API endpoints related to our new Stocktake functionality. Endpoints include:

Stocktake - create a stocktake or request information about an existing stocktake (what about past stocktakes--not physical inventories?)
StocktakeItem - add, edit, or remove an item from a stocktake
StocktakeScannedItem - records scanned items, check if an items has been scanned, or retrieve information about scanned items
StocktakeSection - supports creating, editing, and viewing information about stocktake sections, whether or not they're part of a stocktake in progress
StocktakeSectionTable - information about stocktake tables

Modified Resources

ComboProductSet - added fields and removed fields
We've removed the cc_number field from the Customer resource.
In the Device resource, we've made some changes to the third_party_id field.
We've added some fields to the KitchenView resource to accommodate the new paid stamps, stale timers on expedite view.
In the Modifiers resource, we've changed the default value of the printers field from False to True.
We've added split_combo_data information to the ModifierItem to work with the new split combos feature.
We've added combo_type, parent_combo_uuid, and combo_fraction_part fields to the OrderItem resource to work with split combos.
In the OrderItemCatering resource, we've added catering_for_child_orderitems and modifieritems. We've also added support for the GET HTTP method to simply fetch data.
The PosStation resource now includes an enable_new_kiosk field to enable the Kiosk XT.
The Product resource now includes a list_printers field, which can be populated with a list of data. The is_combo field has also been modified to include support for split combos and is no longer False by default. The printers field value has been modified.
The ProductModifier resource now includes product and establishment fields. In addition, the product_modifier_class now has a default value of True. You can also filter by product and establishment, but no longer by product_modifier_class.
The ProductPurchase resource now has a list_printers field, which can be populated with a list of data. The is_combo field has also been modified to include support for split combos and is no longer False by default.
The Role resource now includes a rank field.
The ServiceFee resource now includes a variable_fee field as part of Revel's support for variable service fees. In addition, the qualification_product_groups and qualification_product_classes fields are now False.
The ViewPurchaseOrderProduct now includes a list_printers field, which can be populated with a list of data. The is_combo field has also been modified to include support for split combos and is no longer False by default.

Changes and Bug Fixes

The ProductRecipe and IngredientRecipe resources currently do not support creating duplicate recipes for the same Product and Ingredient via the API.

We've added a Manager field to the Voids_Summary JSON report.

In the Online Ordering API, When creating WebOrder POST resources in the /specialresources/cart/ includes a call_number field, which is optional but must be an integer.

{
"establishmentId":1,
"call_number": "8",
	"items":[
		{"modifieritems":[],
		"special_request":"",
		"price":5,
"product":15,
"quantity":1
],
	"orderInfo":
		{"created_date":"2019-06-12T13:40:47",
		"pickup_time":"2019-06-12T14:10:47",
		"dining_option":0,
		"notes":"",
		"asap":true,
		"customer": {"phone":"5555555555",
			"email":"[email protected]",
		    "first_name":"Test",
            "last_name":"Test"},
            "call_name":"Test"},
"paymentInfo":       
{"tip":0,"type":4}
}

Removed Resources

We've removed the ItemTrackingReport resource.

Planned Deprecation

We will be deprecating public access to the Brand, Device, KitchenView, CustomerHistory, RewardsCardV3, and InventoryStockAmount resources in our next release, tentatively scheduled for 2.59 in Q1 2020.