nuVizz
Documentation Powered by ReDoc

Event API from External Systems (7.0)

Download OpenAPI specification:Download

License: nuVizz SaaS License

Authentication

BasicAuthentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Change Log

API Change Log

Version Date Changes Comments
7.0.0 Jun 1, 2020 Initial Version

Terminology

The document assumes native nuDeliverIt field-naming conventions. nuDeliverIt can be used in a wide variety of business delivery application and the field names represented here may not directly represent the use of these fields in your specific application.

It is recommended to read this document along with the understanding of integration of inbound interfaces.

Document Terminology nuDeliverIt Use Associated Industry Terminology
Stop Destination for performing work activities such as delivery, pickup, service, field work etc. Customer location, destination, site.
Load/Route A sequence of stops combined and assigned to a person. The load contains all the stops in the sequence. Work schedule, Route, truck path, delivery run, service run.
Driver Represents the personnel deployed for the Load Driver, trucker, delivery man, technician
Comments Set of instructions sent to the driver. Comments can be associated with the stop or the load. Note: Only specific comment types are sent to the driver. Special instructions, delivery instructions, Customer request.
Product Identifier Used to uniquely identify the product during delivery/pickup or use. This could represent the bar code if scanning is used in the system. SKU barcode, Package barcode, Item barcode, service number, part, pickup tracking number, delivery tracking number.
Host This indicates your server from which orders or routes will be sent to nuDeliverIt server Server

Event Definitions

Events follow a sequence of execution with event codes and event names

Event Code Description
Route Level Events
route.initiated Driver has engaged with the route. Also used to assign a driver to the route
route.origin.arrival Driver has Arrived from the Origin location
route.origin.depart Route has departed from the Origin location
route.depot.arrival Route has Arrived at the Return to Depot. Only available when route is configured for it
Stop Pickup Events
stop.pickup.arrival Driver has arrived at the location of the stop
stop.pickup.confirmation Driver has confirmed items at location
stop.pickup.closed Stop execution cannot be performed for a reason
stop.pickup.departure Stop Depart event. Not required if autoDepart is sent in events above
Stop Dropoff Events
stop.dropoff.arrival Driver has arrived at the location for the stop
stop.dropoff.confirmation Driver has confirmed of items at location
stop.dropoff.closed Stop execution cannot be performed for a reason
stop.dropoff.departure Stop Departure at drop off. Not required if autoDepart is turned on

API Events

External Events

Events are used to communicate the journey of the route from the beginning to its completion. Events have a EventCode, Route & GeoStamp associated with them.

Some events are optional such as stop.pickup.depart or route.depot.arrive. These are controlled by Configuration and message level overrides

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company code to which the Route belongs

Request Body schema: application/json
eventCode
required
string <= 50 characters

Event Code corresponding to the event being reported. Valid Event Names are specified in the Summary above

  • route.initiated
  • route.origin.depart
  • stop.pickup.arrival
  • stop.pickup.confirmation
  • stop.pickup.closed

    For an exhaustive list view the table in Event Definition

geoStamp
required
object (GeoStamp)
routeNbr
required
string <= 30 characters

Unique Route Nbr that the Driver is working on

stop
object (Stop level event Data)

Responses

200

Success

400

Bad request; request contains invalid data

401

You are not authorized to access the resource

404

The resource you were trying to reach is not found

409

No information available for the provided request parameters.

500

Internal server error

post /event/{companyCode}
https://contact-support.nuvizz.com/deliverit/eventapi/v7/event/{companyCode}

Request samples

Content type
application/json
Example
RouteInitated
Copy
 Expand all Collapse all
{
  • "eventCode": "route.initiated",
  • "geoStamp":
    {
    },
  • "routeNbr": "RTE0032"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Reasons":
    [
    ]
}

GPS Events

External GPS

GPS Event Endpoint is used to receive the current location of the route as the driver travels. The route location is used to calculate ETA updates and send customer communication.

All gps events must have a routeNbr and geoStamp attached. Geo Location is tagged between route start and route end. Any updates sent outside of these times are ignored.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company code to which the Route belongs

Request Body schema: application/json

GPS API. To see examples look at the sample code to see examples of each event

geoStamp
required
object (GeoStamp)
routeNbr
required
string <= 30 characters

Unique Route Nbr that the Driver is working on

Responses

200

Success

400

Bad request; request contains invalid data

401

You are not authorized to access the resource

404

The resource you were trying to reach is not found

409

No information available for the provided request parameters.

500

Internal server error

post /gps/{companyCode}
https://contact-support.nuvizz.com/deliverit/eventapi/v7/gps/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "geoStamp":
    {
    },
  • "routeNbr": "RTE00233"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Reasons":
    [
    ]
}