Custom order data in browser storage

Before the payment orders in POS are kept in browser storage. Thereby if we again open POS module (should not be confused with the closing of the session) the system automatically retrieves data from the storage.

If your model adds data (of the field), then you need to make additional data processing in order to save this data among reopenings.

Because of the browser storage (localStorage) allows saving data only with the type String POS converts the Order object to the String and inversely.

For this purpose following methods are used:

  • init_from_JSON: function reads parameters of the order from the json-String and saves to the current object (see realization of the Orderline here and for the Model there)
  • export_as_JSON: function converts the current object to json-String (see realization of the Orderline here and for the Model there)

When order is updated export_as_JSON is called and data are saved to browser storage.

Now, if you close page and reopen, then at some point init_from_JSON is called to restore order from json string.

Let’s take the example:

POS Advanced Order Notes module

This module allows adding notes to the entire order, to use already predefined notes and to speed up the process of creating orders by specifying products also via notes, which can be automatically applied further.

export_as_JSON: function () {
  var data = _super_order.export_as_JSON.apply(this, arguments);
  data.note = this.note;
  return data;
init_from_JSON: function (json) {
  this.note = json.note;, json);

When you add the note to your Order, the trigger which calls export_as_JSON launches to convert data of current order into string (including notes) and save it in browser storage.

While loading POS in order to get saved notes from the browser storage, you need to extend init_from_JSON function.

Without this code, your module will work, but if you reload POS, your notes will not be presented (because they are not saved).