External documents in order fulfillment

External documents can be added 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.

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

Adding an external document

A document can be added to the pack job section by performing the following POST call with the JSON body:

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

{
    "type": "PDF",
    "section": "PACKJOB",
    "file": {
        "name": "invoice.pdf",
        "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg=="
    }
}

Currently only files of type PDF can be uploaded.

Assigning documents to sections

Using the section field in the request object, users can assign the document to a specific section. This way it can be controlled 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

An (empty) placeholder document can be added early in the process, so when a user opens the printing section and the document is not available yet, 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.

It can be added by performing the following POST call with the JSON body:

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

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

Updating an external document

Once the final document is available, it can be added to the process entity using PUT to modify the document:

A document can be added to the process entity by performing the following PUT call with the JSON body:

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

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