Load unit configuration

It is possible to use load units within the picking process. Load units can be any kind of custom items which complement the picked task, such as bags, boxes, vouchers, or any kind of goodies / information that the picker should get once the picking process is finished.

Creating a load unit type

While the load unit entity captures the information for a particular pick job, the load unit type entity is the configuration object.

To create a load unit type entity, do the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/loadunittypes

{
    "nameLocalized": {
        "de_DE": "Papiertasche",
        "en_US": "Paperbag",
        "pl_PL": "Torba papierowa"
    },
    "priority": 1
}

Update a load unit type

To update/modify an existing load unit type, do the following PATCH call with the JSON body:

PATCH https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/loadunittypes/<loadUnitTypeId>

{
    "version": 3,
    "actions": [
        {
            "action": "ModifyLoadUnitType",
            "priority": 2
        }
    ]
}

All defined load unit types will be immediately displayed for selection in the picking process. If there are no load unit types defined, this step is skipped in the app.

Once a load unit type has been defined, it cannot be deleted via the API. Please contact us if you require assistance in this scenario.

Add an icon to a load unit type

An icon can be added to the load unit type definition so that it is displayed in the Operations app and the picker knows which bag, box, etc. to choose. The image file needs to be base64 encoded in the HTTP request.

To add an icon to an existing load unit type, do the following PUT call with the JSON body:

PATCH https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/loadunittypes/<loadUnitTypeId>/icon

{
    "name": "paperbag.png",
    "content": "==base64-encoded content=="
}