Requesting

Requesting

To request a barcode means to create a task with barcode data that will inform the driver that one or more barcodes should be scanned prior to completing a task. You can optionally block task completion on a per barcode basis, effectively turning your barcode request into a barcode requirement.

In order to request barcodes for a task, you can create a new task or update an existing task while providing the barcodes object array, top-level task property.

The structure of the object members of this array property is as follows:

Name

Type

Description

data

string

Optional. Base64 representation of the data encoded within the barcode to be captured, max length of 500 characters

blockCompletion

boolean

Optional. Whether the worker must capture this data prior to task completion, defaults to false

{
    "data": "aGVsbG8gd29ybGQh", // string, the base64 representation of the data encoded within the barcode to be captured, max length of 500 characters

    "blockCompletion": true // boolean, whether the worker must capture this data prior to task completion, defaults to false
}

Requesting a barcode will ensure that your driver can see the barcodes requested when they are about to complete a task. The driver will be prevented from completing the task unless all requested barcodes with blockCompletion set to true have been captured.

If you would like to request that any barcode be scanned, regardless of data, you may simply omit the data property in your request.