Order Events

The Order Events APIs (api.events.order) provide access to order events.

When an OrderUpdates object is the expected response from the handler, the POS post-processes the value.

Data in the additionalOrderProperties field of the returned object is stored in the additional_properties field of the order.

// To save data on a finalized order use any unique field name
// In this example the name 
// "fiscal_transaction" is used for transactional data

api.events.order.onOrderFinalized(order => {
   if (order.additional_properies) {
      // Access previously generated data
      console.log('Previous transaction data:', order.additional_properies.fiscal_transaction);
   }
   // Create and return new data to be saved in the order object.
   const fiscalTransaction = {
      id: '1234', // some identifier
      ... // other data
   }
   const additionalOrderProperties = { 
      fiscal_transaction: fiscalTransaction 
   }
   const orderUpdates = { 
      additionalOrderProperties 
   };
  
   return Promise.resolve(orderUpdates);
});

In this case a handler prints an order or kitchen receipt with an expectation of returned data of the appropriate printingInfo. This printing event is be tracked for the order.

api.events.order.onOrderFinalized(order => {
   // Print an order receipt (customer copy)
   ...

   // Include appropriate printing info for the returned value
   const printingInfo = {
      printingType: 'customer'
   }
   const orderUpdates = { 
      printingInfo 
   };
   return Promise.resolve(orderUpdates);
});

api.events.order.onOrdersCombined(params => {
   // Consider there were three orders: order1, order2, order3.
   // And then those orders got combined into order1.
   // targetOrder will be a reference to object order1 before combine.
   console.log('order1:', params.targetOrder);
   
   // order2 and order3 (before combine) can be accessed through params.
   combinedOrders:console.log('order2 and order3:', params.combinedOrders);

   return {};
});