API Reference

Line Level Data

👍

The Line Level Data (LLD) feature allows for tracking and input of data on individual items within a job.

Once enabled, drivers will be able to provide data about the items included in the job during its completion.

This feature aims to provide flexibility to merchants accounts in tracking individual items within a job and allows the drivers to update information on-the-go.

Parameters

NameTypeRequiredDescription
idstring✅ YesJob ID required for lookup (Radaro Job ID or external job ID depending on the lookup field). Example: "2345"
keystring✅ YesAPI access key. Example: "a46dfc0e-4b59-448d-8a41-0745af6458ff"
lookup_fieldstring❌ NoField name for job lookup. Default: "external_id".
Allowed values: "external_id", "order_id"

Overview

  • Merchants can select a specific set of fields that they want to associate with each job.
  • Drivers will be able to edit/fill these fields during job completion with the necessary information.
  • A job can have multiple items (5, 10, 20, 30, and more) attached to it, bundled into one “Line Level Object”.
  • Merchant Settings will also include a configurable list of positive (successful) and negative (failed) reasons that can be associated with Line Level Data objects.
  • A Reason Code will be input by the driver after selecting an answer for the “Delivered”/”Picked up” fields.
  • In addition to the reason, the driver will have the option to add a comment.

Driver Permissions

  • Drivers will only be able to edit LLD items; they will not have the ability to add or delete items.
  • Editing of LLD items is restricted to when the job statuses are “Picked up” & “In Progress”.
  • LLD items can be edited in Offline mode in mobile apps.

Manager Permissions

  • Managers will have the ability to add/change LLD in all statuses except for “Way Back”, “Completed”, and “Failed”.

Job Statuses

  • It will be possible to change the job status even if not all LLD items are marked as “delivered”/”picked up”.

LLD Item Statuses

  • LLD item statuses cannot be changed to “delivered”/“not delivered” if they contain the “picked_up” field in the “false” state (“not picked up”).
  • LLD item statuses cannot be changed to “delivered”/“not delivered” while job is in “picked up” status.

Fields that can be toggled on/off by the merchant:

  • picked_up
  • delivered
  • picked_up_reason
  • delivered_reason
  • bulk_quantity_picked_up
  • bulk_quantity_delivered
  • width
  • height
  • length
  • weight
  • price

You could add/update/delete job's line level data together with job update.