External documents

External documents that are relevant during order fulfillment can be added to the order process. As a result, these documents can be, for example, printed via the Operations app or can be used by other clients to upload or change documents during processing.

A typical use case is to attach a branded invoice document which is generated outside of the fulfillmenttools platform. Such a document can be added to the process to be printed and added to the parcel during order fulfillment.

External documents can be assigned to a section, depending on the operational process in which it is needed. This way it can be configured in which part of the app the document is displayed, e.g., in the Picking, Packing, or Handover section.

External documents can be added to the process entity. This allows the documents to be selected for printing within the mobile application or to be uploaded or modified by other clients during fulfillment processing.

The print and document configuration must be checked as well when setting up printing of external documents.

Adding an external document

To add a document to a process, perform a POST request with a JSON body to the following endpoint:

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/processes/<processId>/documents

{
    "type": "PDF",
    "section": "PACKJOB",
    "file": {
        "name": "invoice.pdf",
        "content": "<base64-encoded-file-content>"
    }
}

The system only supports uploading PDF files.

Document sections

The section field in the request object assigns the document to a specific part of the fulfillment process. This controls where in the application the document is displayed.

The following sections are supported:

• PACKJOB

• PICKJOB

• HANDOVERJOB

Placeholder documents

A placeholder document can be created early in the process without any file content. When the printing section is opened and the final document is not yet available, information about the pending document is displayed. Adding placeholders is optional, but it improves the user experience for the warehouse staff.

To create a placeholder, perform a POST request to the same endpoint with the following JSON body:

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/processes/<processId>/documents

{
    "type": "PDF",
    "section": "PACKJOB"
}

Updating an external document

Once a final document is available, it can be uploaded to replace a placeholder or update an existing document. To modify a document, perform a PUT request with the documentId and a JSON body containing the file.

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/processes/<processId>/documents/<documentId>

{
    "version": 1,
    "file": {
        "name": "invoice.pdf",
        "content": "<base64-encoded-file-content>"
    }
}