Print / Document Configuration

If documents are needed in the operational process, for e.g. while picking or packing you can add those as follows.

Document types are:

  • Shipping label

  • Return label

  • Delivery note

  • Return note

  • External documents

If you want to learn how to add external documents to your processes, please visit our external documents page.

Instructions

PUT on /api/configurations/tags/pickjob

OR /api/configurations/tags/packjob. Depending on which process steps it’s needed.

{
    "version": 1,
    "offeredDocumentsByDefault": [
        {
            "documentCategory": "SENDLABEL"
        },
        {
            "documentCategory": "EXTERNAL"
        }
    ]
}

It’s up to you, if you like to handle it per default means for every pickjob/packjob the same or via tags. Tags can be helpful to handle pickjobs/packjobs differently. For example a marketplace order needs other documents than orders from it’s own store. Then do this:

    "offeredDocumentsPerTag": [
        {
            "tagRef": "TAG-ID",
            "matchingValues": [
                "MUST-MATCH-VALUE-IN-TAG"
            ],
            "offeredDocuments": [
                {
                    "documentCategory": "EXTERNAL"
                }
            ],
            "tagRef": "TAG-ID",
            "matchingValues": [
                "MUST-MATCH-VALUE-IN-TAG"
            ],
            "offeredDocuments": [
                {
                    "documentCategory": "RETURNNOTE"
                }
            ]
        }
    ]

If you handle it via tags, then every order/pickjob/packjob needs a tag, when it’s created

    "tags": [
        {
            "tagRef": "string",
            "value": "string"
        }

Effect in the fft clients:

If it’s configured in pickjobs you see this:

If it’s configured in packjobs you see this:

Last updated