Add Note/POD (Proof of Delivery)

Use this API to update an order/delivery or send Proof of Delivery (POD) when one of the following driver actions takes place:

  • Driver adds a note / comment
  • Driver collects the customer's signature
  • Driver takes a photo
  • Driver fills in a form
  • Driver uploads a document

You can upload raw binary files (signature, image, PDF) with "multipart/form-data" Content-Type as well as with base64 format.

🚧

Image Types Allowed

Only images of type JPEG or PNG can be uploaded.

📘

Notes and POD can be sent AFTER an order/delivery has been completed.

EXAMPLE PAYLOADS

{
  "task_id": 9095936,
  "way_point_position": 2,
  "user_external_id" : "test_driver1",
  "type" : "TaskNote",
  "note": "1st waypoint note",
  "external_id": "note1",
  "lat": 40.671629,
  "lng": -73.875033,
  "reported_time": 1591272971000
}
{
    "task_id": 9095936,
  "way_point_position": 2,
  "user_external_id" : "test_driver1",
  "type" : "TaskPhoto",
  "image": "data:image/jpeg;base64,9j/4AAQSkZJRgABAQEAkACQAAD/4QBaRXhpZgAATU0AKgAAAAgABQMBAAUAAAABAAAASgMDAAEAAAABAAAAAFEQAAEAAAABAQAAAFERAAQAAAABAAAXEVESAAQAAAABAAAXEQAAAAAAAYagAACxj//bAEMAAgEBAgEBAgICAgICAgIDBQMDAwMDBgQEAwUHBgcHBwYHBwgJCwkICAoIBwcKDQoKCwwMDAwHCQ4PDQwOCwwMDP/bAEMBAgICAwMDBgMDBgwIBwgMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAnICcgMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQY......RRRQB//2Q==",
  "reported_time": 1591272971000
}
{
    "task_id": 9095936,
  "way_point_position": 2,
  "user_external_id" : "test_driver1",
  "type" : "Signature",
  "image": "data:image/jpeg;base64,9j/4AAQSkZJRgABAQEAkACQAAD/4QBaRXhpZgAATU0AKgAAAAgABQMBAAUAAAABAAAASgMDAAEAAAABAAAAAFEQAAEAAAABAQAAAFERAAQAAAABAAAXEVESAAQAAAABAAAXEQAAAAAAAYagAACxj//bAEMAAgEBAgEBAgICAgICAgIDBQMDAwMDBgQEAwUHBgcHBwYHBwgJCwkICAoIBwcKDQoKCwwMDAwHCQ4PDQwOCwwMDP/bAEMBAgICAwMDBgMDBgwIBwgMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAnICcgMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQY......RRRQB//2Q==",
  "reported_time": 1591272971000
}
{
  "task_id": 9095936,
  "way_point_position": 2,
  "user_external_id" : "test_driver1",
  "type" : "Form",
  "data": "{\"Name\": \"John Smith\", \"Address\": \"1 Main Road\"}",
  "lat": 40.671629,
  "lng": -73.875033,
  "reported_time": 1591272971000
}
{
  "task_id": 9095936,
  "way_point_position": 2,
  "user_external_id" : "test_driver1",
  "type" : "HtmlTaskNote",
  "note": "Link to Bringg",
  "url": "https://www.bringg.com",
  "external_id": "note2",
  "lat": 40.671629,
  "lng": -73.875033,
  "reported_time": 1591272971000
}
{
  "task_id": 9095936,
  "way_point_position": 2,
  "user_external_id": "test_driver1",
  "type": "Document",
  "file": "data:application/pdf;base64,9j/4AAQSkZJRgABAQEAkACQAAD/4QBaRXhpZgAATU0AKgAAAAgABQMBAAUAAAABAAAASgMDAAEAAAABAAAAAFEQAAEAAAABAQAAAFERAAQAAAABAAAXEVESAAQAAAABAAAXEQAAAAAAAYagAACxj//bAEMAAgEBAgEBAgICAgICAgIDBQMDAwMDBgQEAwUHBgcHBwYHBwgJCwkICAoIBwcKDQoKCwwMDAwHCQ4PDQwOCwwMDP/bAEMBAgICAwMDBgMDBgwIBwgMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAnICcgMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQY......RRRQB//2Q==",
  "reported_time": 1591272971000
}

❗️

Documents

Make sure these are PDF etc files. Sending an image file as a "Document" type will not work.

Rather use the "TaskPhoto" type if your documents are in an image format.

BODY PARAMS

*task_id

Int32

The unique Bringg Order ID.

way_point_position

Int32

Identifies the way point (stop) number. Possible values are 1 (pickup/store/warehouse) or 2 (dropoff/customer). If you specify the position, you don't need to specify the way_point_id.

way_point_id

Int32

Bringg ID of the way point with which this note is associated. EITHER this field OR way_point_position is required.

user_external_id

string

The ID of the driver in your system. Use this to specify that the driver was the author of the note.

*type

string

The type of note. Possible values include:

  • TaskNote
  • Signature
  • TaskPhoto
  • Form
  • Document
  • HtmlTaskNote

note

string

Text of the note

image

string

This needs to be in Base64 data format

file

string

Base64 data

data

string

Stringified JSON of the form content. Can contain any JSON object/array e.g. "{\"key\": \"value\"}"

url

string

Hyperlink for the HtmlNote

lat

double

The latitude of where the driver was when the action took place

lng

double

The latitude of where the driver was when the action took place

reported_time

integer

Unix Epoch time in milliseconds when the action took place

  • Mandatory fields

📘

What Bringg will send in response

{
    "success": true,
    "task": {
        "id": 12178551,
        "note": "1st waypoint note",
        "user_id": 662319,
        "task_id": 9095936,
        "created_at": "2020-06-28T11:20:14.105Z",
        "updated_at": "2020-06-28T11:20:14.105Z",
        "url": null,
        "way_point_id": 13755996,
        "customer_id": null,
        "pending_upload": false,
        "lat": 40.671629,
        "lng": -73.875033,
        "form_group_uuid": null,
        "action_id": null,
        "task_inventory_id": null,
        "flow_uuid": null,
        "happened_at": null,
        "form_field_key": null,
        "external_id": "12178551",
        "share_with_customer": false,
        "type": "TaskNote"
    }
}
{
    "success": true,
    "task_photo": {
        "url": "https://storage.googleapis.com/bringg-prod-us2-task-images/uploads/task_photo/url/12178619/01acbe3b-f95f-4[email protected]bringg-prod-us2.iam.gserviceaccount.com&Signature=JVxYr7T44dHgNKeqSY4CAmh5UPtl%2Ba5Q2Q9AcSGNn95tVUc%2B2Y14zDCTbWQg%0Aj571zD9Yibc1fJkzMhErYm9BUC69OHKs85BMD21AU6X1JmBA%2BF5tjVlWfgbV%0AqUc4AegkbECqckm8KCFfntk6O04hdi8SPcneC70sE3gF5JtIlEB60viTe4Sm%0AsHsZ8IMUfkqg2UnlIrETzcVYLG82zSi%2Bg2Ca7p94%2FUmMkqebdedFWmn4I7ZF%0Ah82qNSK47svWxdcaL3G2soTtTvwwohVfyOHOUvqqWJRN4RG2J31hvAh8FK9D%0AqfJ2%2Fw4TShAIoFIERAySjt9mfuqZF5ID%2BGVoEir8Gw%3D%3D&Expires=1593430619",
        "task_id": 9095936,
        "created_at": "2020-06-28T11:36:57.813Z",
        "title": "28 Jun, 2020 11:36 AM, Test Driver1",
        "author_name": "Test Driver1",
        "way_point_id": 13755996,
        "id": 12178619,
        "lat": 40.671629,
        "lng": -73.875033,
        "form_group_uuid": null,
        "thumbnail_url": "https://storage.googleapis.com/bringg-prod-us2-task-images/uploads/task_photo/url/12178619/thumbnail_01acbe3b-f95f-4[email protected]bringg-prod-us2.iam.gserviceaccount.com&Signature=yIGGLg%2BaRoVKVZXZ2t0iEw57UYHw90g0PfJzCfNfTuD%2Ft%2BEA8Edje4sa03ck%0AZRT3r27bCFgtJ24Z0NMkUWPrNph4c7OOzRuc79leb1jvN7GweN2ItG%2FuigeZ%0APA2xPqT2NDtGc0l%2FIhQLLvR85GrVSjWGUatvvUXqXeG2rxorWSKmA0NmhpS1%0AC%2B6hMo3l90RzWhJtcAwkQgFE48hBB4oZBBHf20qJEKmYPWe%2B4vIc0jKLuj3B%0AvyTnYvM0YjW36%2FlwKat5cee3KDYbWIf211%2B5AyME0Qu%2BuxOqMs6su9ETIwIw%0A4QWUjJfbKOSa7S2XXm8PAiQ5nilYfNhookVHUOo%2BMw%3D%3D&Expires=1593430619",
        "medium_url": "https://storage.googleapis.com/bringg-prod-us2-task-images/uploads/task_photo/url/12178619/medium_01acbe3b-f95f-4[email protected]bringg-prod-us2.iam.gserviceaccount.com&Signature=KHqC7IGRTgjzAhdlRlRdVFkTp5R5KvDS3FtEtIeF99K9QHhgvQ0Dp7oY1u8X%0A78Ek%2FhxdR2t2TadPeBrCM8SezHwRJr%2BN983vyp3HQvBVwO7C6WZa3FcSTyJX%0A9NbYqEndNnSVzZ%2FPFfAnJs%2BJgjEDWNGzBYQ%2FYaS7N5OCyLI36zR2Si9PP8Ed%0AlozHh3bM9rqVaztemCJy1G80rRlxYEFnnQ1MRkH8tb%2FZcN57UfN1mxhUuvP0%0AZflyydKeWZvkkgrIMdGc44LJQAwufPjbp%2F2yGIycIi7985tLnZ1tAgMg5cUJ%0ANvzOk5CCV8dIvK8SHSSQ46APwI1Zv1Eytbw%2F6668Mw%3D%3D&Expires=1593430619",
        "action_id": null,
        "task_inventory_id": null
    }
}
{
    "success": true,
    "task": {
        "id": 12178656,
        "note": "Link to Bringg",
        "user_id": 662319,
        "task_id": 9095936,
        "created_at": "2020-06-28T11:47:28.462Z",
        "updated_at": "2020-06-28T11:47:28.462Z",
        "url": "https://www.bringg.com",
        "way_point_id": 13755996,
        "customer_id": null,
        "pending_upload": false,
        "lat": 40.671629,
        "lng": -73.875033,
        "form_group_uuid": null,
        "action_id": null,
        "task_inventory_id": null,
        "flow_uuid": null,
        "happened_at": null,
        "form_field_key": null,
        "external_id": "note2",
        "share_with_customer": false,
        "type": "HtmlTaskNote"
    }
}
{
    "success": true,
    "task_signature": {
        "url": "https://storage.googleapis.com/bringg-prod-us2-task-images/uploads/signature/url/12178931/729ff14c-4c04-4[email protected]bringg-prod-us2.iam.gserviceaccount.com&Signature=FOqNVWfqRhsJBz6OZUM3%2B4CH83ixffedQ43DYFogz%2FwVEGgOa5fhf2XFVZov%0AFmWf9JO2%2Fd37xoXj4Su6goGkPfxJwYIT9wUu4FEtnC%2BXJWXzwTn0MGcirTY%2F%0Ac06QgBm1N%2FEbvwds4w7Yrm%2B08luVwevtZAjRS7LWSbBZGLu7KFu9XtJBUhPW%0Auj0WiIABTezD5uYH7T%2F8Ksj%2FFgeLa9zN%2BVGNR%2BbuuT8%2BIPAEC9TeSJkiygrC%0ArAWQYTPl7pAS%2F6v%2BtQrJC0RSg3veyUEiGocqJPcwk%2BuVyGTJg0JRG70bWdNv%0Axzx8%2FiaqCZ4Xjz51ekMg9sTveo1fPzez2iaZ8UwIgQ%3D%3D&Expires=1593434036",
        "task_id": 9095936,
        "created_at": "2020-06-28T12:33:55.988Z",
        "title": "28 Jun, 2020 12:33 PM, Test Driver1",
        "author_name": "Test Driver1",
        "way_point_id": 13755996,
        "id": 12178931,
        "task_inventory_id": null
    }
}
{
    "success": true,
    "rc": 0,
    "form": {
        "title": "28 Jun, 2020 12:44 PM, Test Driver1",
        "note": {
            "Name": "John Smith",
            "Address": "1 Main Road"
        },
        "created_at": "2020-06-28T12:44:51.375Z",
        "author_name": "Test Driver1",
        "id": 12179009,
        "way_point_id": 13755996,
        "url": null,
        "type": "Form",
        "user_id": 662319,
        "lat": 40.671629,
        "lng": -73.875033,
        "form_group_uuid": null,
        "action_id": null,
        "task_inventory_id": null,
        "external_id": "12179009",
        "task_id": 9095936,
        "form_field_key": null
    },
    "signature": null
}
{
    "success": true,
    "document": {
        "task_id": 9896721,
        "created_at": "2020-07-02T14:24:47.448Z",
        "title": null,
        "way_point_id": 14840469,
        "id": 12600062,
        "task_inventory_id": null,
        "url": "https://storage.googleapis.com/bringg-prod-us2-task-images/uploads/document/url/12600062/80fd041c-586c-[email protected]bringg-prod-us2.iam.gserviceaccount.com&Signature=Ec89tffSy3EZQGmW7FQEUImUWnxlL%2B8MW5YIoJm4YVJeu3RjIb0AbAgYL24i%0AIkyn7Lu2Z%2BTKccny%2FIpCU8Hi%2FRJMNhj5cidZrfzyLRnhVlxZdgE0XtPqeFTj%0AKHynWozn%2BO6uCTgqibD%2FfcKWU8nPlXrVOqgYlOSu%2BqDrI%2B8IGvC1ckt2V32h%0AG%2BzXBiJr5jIkWJtBJoxJ%2FefxGTvTtbDquX5jJyvcSaJERcIR9d%2F%2B8qRcoXY1%0A0LE3Nkb941%2FX8ujjRSGTCaPeL4QXGyFANU8mrHSZgJ8nIJHDIb8UDNEDMJ11%0AO8OWI1UJjkSE9Sq%2FyHEkb3fUdMlXqDZ70z4RshTXTg%3D%3D&Expires=1593786287",
        "author_name": "Lewis Hamilton"
    }
}