You can add external documents to the process entity so that these documents can be selected for printing in the mobile app or they can be used by other clients to upload or change documents during processing.
If you want to view added external documents in one of our clients, please also check the print / document configuration.
Adding an external document
In this example we are going to add a PDF document to the process using the POST /api/processes/<processId>/documents endpoint. Specifically, we want to add it to the PACKJOB section because in this example, labels and documents should be displayed and printed during Packing.
Subscribe to PACK_JOB_CREATED webhook events as described in the
Using the section field in the request object, you can assign the document to a specific section. This way you can control in which part of the app the document is displayed, e.g. in the Picking, Packing, or Handover section.
Currently, the following sections are supported: PACKJOB, PICKJOB, HANDOVERJOB
Adding placeholder documents
You can add an (empty) placeholder document early in the process, so when a user opens the printing section and the document is not available yet, at least an information is shown in the "External documents" section.
Adding placeholder documents is optional but recommended, since it improves the usability of the process for picking staff.
Updating the document
Once the final document is available, you can add it to the process entity in a similar fashion, but this time you have to use PUT to modify the document:
