Any Scan

The Any Scan callback occurs when any scan occurs. This callback returns detailed information describing the scan.

📘

Registering Your URL for the Customer Tipped Driver Webhook

For information describing how to register your URL for a webhook, see Bringg Webhooks.

Response

{
	"scan": {
		"id": 868767,
		"task_id": 8922584,
		"way_point_id": 11117859,
		"user_id": 77484,
		"scanned": true,
		"scan_string": "9781589395848",
		"created_at": "2017-12-25T19:10:53.941Z",
		"updated_at": "2017-12-25T19:10:53.941Z",
		"lat": 32.0940143,
		"lng": 34.8282898,
		"manual_scan": false,
		"inventory_id": null,
		"task_inventory_id": null,
		"scanning_role": 0,
		"delete_at": null,
		"type": "BarcodeScan"
	}
}

Output Params

id

Int32

The Id of the scan.

created_at

datetime

The date and time the scan was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

delete_at

datetime

If the scan value was deleted, this is the date and time of the deletion. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

inventory_id

Int32

The Id of the task inventory item.

lat

double

The geoposition latitude of the user (driver) when the scan was done.

lng

double

The geoposition longitude of the user (driver) when the scan was done.

manual_scan

boolean

Indicates whether the scan value was manually entered. The values are:

  • false or 0 - the scan was not manual
  • true or 1 - the scan was manual

scan_string

text

The value of the scan.

scanned

boolean

Indicates whether this is done. The values are:

  • false or 0 - the scan is not done
  • true or 1 - the scan is done

scanning_role

Int32

The role of the user performing the scan. The values are:

  • 0 - driver
  • 1 - dispatcher_staging
  • 2 - dispatcher_coc

task_id

Int32

The Id of the order with which this scan is associated.

task_inventory_id

Int32

The Id of the task inventory item scanned.

type

string

The type of scan. The values include:

  • barcodescan
  • ocr

updated_at

datetime

The date and time the scan was last updated. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user with which this scan is associated.

way_point_id

Int32

The Id of the way point with which this scan is associated.