Update Transit Status


How Transit Status works for Driver Networks

See the Overview to understand the entire use case of Driver Network-related API endpoints. These endpoints are related to the My Drivers feature on the web UI for a Service Provider. However, only certain functions on My Drivers is currently available to third party developers through the API.

The dispatcher...

  • is the owner of a driver network.
  • books and assigns listings to a driver in the driver network.
  • can update the transit status for the assigned driver.
  • can transport and update transit status for his or her own booked listing.

If there are no active drivers in the driver network, the booked listing is automatically assigned to the dispatcher.

If the dispatcher is acting as the driver and has an active driver in the network, the dispatcher must choose Assign to Me to provide tracking. Driver assignments can only be done on web (My Drivers) at this time and not through the API.

The active driver...

  • assigned to transport the listing reports location through uShip's app on their mobile device.
  • can update the transit status any time during transport.
  • can enter and release the payment code for the dispatcher. 

Tracking occurs...

on the party transporting the booked listing. Once the dispatcher has assigned a listing to one of the network drivers, the listing must have the "booked" shipment status and the "ReadyForDispatch" transit status.

  • Tracking is reported from the driver assigned to transport the listing.
  • If the dispatcher has no active drivers in the driver network and acts as the driver, then tracking is reported from the dispatcher transporting the listing.
  • Either the dispatcher or the driver may change the transit status at any time during the shipment.

See Tracking Reference.

What Can I Do Next?

A shipper who retrieves a booked listing that has been assigned to a driver in a dispatcher's network will not see the assignedDriver object in the returned listing.

A dispatcher (driver network owner) can retrieve one of his or her booked listings by providing the listing Id. The assigned driver object for the booked listing will return as part of the listing response.

Hypermedia links can include

 "links": [
        {
            "rel": "Create",
            "verb": "POST",
            "href": "/v2/listings/12345678/feedback",
            "title": "feedback"
        },
        {
            "rel": "Item",
            "verb": "GET",
            "href": "/v2/listings/12345678/bids/1234567",
            "title": "acceptedBid"
        },
        {
            "rel": "List",
            "verb": "GET",
            "href": "/v2/listings/12345678/bids",
            "title": "bids"
        },
        {
            "rel": "Item",
            "verb": "GET",
            "href": "/v2/listings/12345678/contacts",
            "title": "contacts"
        },
        {
            "rel": "List",
            "verb": "GET",
            "href": "/v2/listings/12345678/conversations",
            "title": "listingconversations"
        },
        {
            "rel": "Create",
            "verb": "POST",
            "href": "/v2/paymentcodes",
            "title": "activatePaymentCode"
        },
        {
            "rel": "Item",
            "verb": "GET",
            "href": "/v2/listings/12345678/transitstatuses",
            "title": "transitstatus"
        }
    ]

 

An assigned driver can retrieve one of the listings he or she was assigned to deliver by providing the listing Id. The assigned driver object for the booked listing will return as part of the listing response.

Hypermedia links can include

"links": [
        {
            "rel": "Item",
            "verb": "GET",
            "href": "/v2/listings/12345678/bids/1234567",
            "title": "acceptedBid"
        },
        {
            "rel": "List",
            "verb": "GET",
            "href": "/v2/listings/12345678/bids",
            "title": "bids"
        },
        {
            "rel": "Item",
            "verb": "GET",
            "href": "/v2/listings/12345678/contacts",
            "title": "contacts"
        },
        {
            "rel": "List",
            "verb": "GET",
            "href": "/v2/listings/12345678/conversations",
            "title": "listingconversations"
        }
    ]