(Deprecated) Load unit configuration

Load unit types API is deprecated, use instead Operative container types.

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 a load unit captures the information for a particular pick job, the load unit type is the configuration object.

To create a load unit type, send a POST request to the following endpoint with the JSON body.

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

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

Update a load unit type

To update an existing load unit type, send a PATCH request to the following endpoint with the JSON body.

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

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

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

A load unit type, once defined, cannot be deleted via the API. Contact support for assistance in this scenario.

Add an icon to a load unit type

An icon can be added to a load unit type definition for display in the Operations App. This helps the picker identify which item (e.g., bag or box) to choose. The image file must be base64-encoded in the HTTP request.

To add an icon to an existing load unit type, send a PUT request to the following endpoint with the JSON body.

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

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