Set up the order summary printing

When a sales associate completes an order with inStore, they can print a summary of that order, as described in the Print order summary article on Help Center.

To enable this feature, you must follow the steps below to customize inStore's JavaScript file and make additional settings on the inStore app main menu.


Edit the checkout-instore-custom.js file

  1. Open the checkout-instore-custom.js file, available in the Admin of your VTEX account (if you do not know how to access this file, check out the guide on How to customize inStore.

  2. In that file, add the configureDeviceEnabled property with the value true. In addition, add the printingConfig object, and inside it add the printByBroker property, also with the value true.

The code should look like the example below:

window.INSTORE_CONFIG = { 
  configureDeviceEnabled: true, 
  printingConfig: { 
    printByBroker: true 
  },
}

❗️

Do not remove any of the other properties present in the window.INSTORE_CONFIG object, to avoid breaking other functionalities.

  1. After making changes in the code, make sure you press the Save button.

This change will make the Configure device option appear in the inStore main menu. It is through this option that you will configure the printer.


[OPTIONAL] Print automatically

There is an option to automatically print the order summary as soon as the order is completed. To enable it, add the printPageAutomatically property with the value true inside the printingConfig object. See below how the code would look like in this case.

window.INSTORE_CONFIG = { 
  configureDeviceEnabled: true, 
  printingConfig: { 
    printByBroker: true,
    printPageAutomatically: true
  },
}

Configure the printer device on inStore

The next step is to configure the printer on inStore. Make sure you follow the instructions on the Print order summary article on Help Center to do so.

📘

To connect a printer to the inStore system, it is necessary to have a pair of VTEX credentials (AppKey and AppToken) with the appropriate access permissions. Read this Authentication guide to learn more about these credentials.

We recommend that the role linked to these credentials is inStore Sales Person. However, a profile with access to more Admin modules, such as Admin Super, can also be used.


Did this page help you?