nuDeliverit API
Documentation Powered by ReDoc

nuDeliverIt Event Webhooks (6.0)

Download OpenAPI specification:Download

License: nuVizz SaaS License

nuDeliverIt Event Webhooks

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Change Log

API Change Log

Version Date Changes Comments
5.0.1 June 26th 2020 Initial Version
5.0.2 July 7th 2020 Adding DocumentType
5.0.2 July 16th 2020 Doc. updated with fields MaxLength
5.0.2 July 21th 2020 fields updated with MaxLength
5.0.3 Aug 8th 2020 Added RouteName in RouteHeader
5.0.3 Aug 17th 2020 Description updated for documentData
5.0.3 Aug 26th 2020 Added ex. for 7087, 7089, 7085, 8500
5.0.4 Sep 16th 2020 updated dispositionType, documentType, documentExtType to enum
5.0.4 Sep 23rd 2020 shipToZip updated to string
5.0.4 Sep 24th 2020 Added document list in StopDetail
5.0.4 Oct 1st 2020 Updated route departed example
5.0.4 Nov 30th 2020 Updated LineType description
5.0.4 Dec 7th 2020 Updated Confirmed,Scanned quantity fields
5.0.5 Dec 18th 2020 Updated RouteCreated Example
5.0.5 Jan 05th 2021 PuConfirmedQty, PuScannedQty fields added in the Events
5.0.6 Mar 26th 2021 Added carton content fields in the Events
5.0.7 Dec 13th 2021 Added EventCodeName field in the Events
7.1.0 May 12th 2022 Added ConsolidationGroupNbr field in the Events
7.4.0 Jan 02nd 2023 Added RcvDTTM in the Events

About Events

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.
Route A sequence of stops combined and assigned to a person. The route contains all the stops in the sequence. Work schedule, Route, truck path, delivery run, service run.
Driver Represents the personnel deployed for the Route Driver, trucker, delivery man, technician
Comments Set of instructions sent to the driver. Comments can be associated with the stop or the route. 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 barcode 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

What are events

Events are recorded steps that occur on the nuDeliverIt and sent to the portal in real-time. If there is loss of connectivity between the device and portal, the events are reported on the first available data connection. All nuDeliverIt event data (routes & stops) can be reported with date, time and location where the event occurred.

Event Flow

Event Codes

Route Level Events

Event Code Event Code Name Name Description
7000 route.created Route Created Event to indicate when the route was created
7001 route.driver.assigned Route Assigned When a Route is assigned to a driver
7002 route.driver.unassigned Route UnAssigned Event to indicate the route was unassigned from a driver
7004 route.initiated Route Initiated Triggered when driver departs from DC or Hub
7005 route.completed Route Completed Event to indicate that route was completed.
7015 route.suspended Route Suspended Event to indicate when the route was suspended.
7020 route.signature.capture Route Level Signature Confirmation Route Level Signature captured.
7022 route.origin.arrival Route Arrived Event when Route is Arrived at warehouse/depot.
7023 route.origin.depart Route Departed Triggered when driver Departs from the warehouse.
7024 route.updated Route Updated Event to indicate when the route was updated.
7019 route.document.capture Route Doc confirm Route Document captured confirmed.
7033 route.cancelled Route Cancellation Event to indicate when the route was cancelled.
7111 eta.route.departed ETA Route Departed ETA notification for Route departed Event.
7089 route.depot.arrival Return to Depot Arrival Arrival confirmation when a driver returns to the depot with returns.
7085 route.deportreturn.confirmation Return to Depot confirmation Confirmation of delivery of returns at the depot by the driver.

Stop Level Events

Event Code Event Code Name Name Description
7006 stop.geofence.entry Stop GeoFence Entered Event to indicate the driver has entered into the stop geo-fence of one of the stops on their route. The data provided gives the associated route number and stop number
7007 stop.dropoff.arrival Stop Arrival Event to indicate the drivers arrival at the stop (pick or delivery)
7008 stop.dropoff.departure Stop Departure Event to indicate the driver’s departure from the stop
7009 stop.dropoff.delivery Stop Delivery Event to indicate the confirmation of pickup/delivery at the stop
7010 stop.dropoff.signature.confirmation Signature Confirmation Signature confirmation has been accepted.
7014 stop.dropoff.document.capture Document Capture Event to indicate, if any PDF documents are involved or camera capture of photos at the stop
7021 stop.closed Stop Closed Event to indicate when the stop was closed
7026 stop.confirmation.email Send Stop Confirmation Sending stop delivery confirmation.
7028 stop.plannedon.route Stop Planned Event to indicate when the stop was planned into a route.
7029 stop.unplanned.route Stop Unplanned Unplanned stop created or stop removed from route back to Unplanned status.
7032 route.carrier.reject Rejected By Carrier Assigned route or assigned Stop is rejected by Carrier.
7044 stop.admin.reopen Stop Reopened Event to indicate the when the stop was reopened
7052 route.partner.unassigned Business Partner Un-assignment Triggered when Business Partner is unassigned.
7053 stop.updated Stop Updated Event to indicate when the stop was updated
7059 stop.cancelled Stop Canceled Event to indicate when the stop was cancelled
7068 stop.pickup.confirmation Pickup Stop Confirmation Triggered when Pick up confirmation is done for all delivery Stops within a Route.
7087 stop.returns.pickup Pick up returns at Stop Pick up of returns confirmed at Stop.
7114 eta.stop.delay Published ETA breach alert Change in ETA of the routes or stops when in transit beyond the allowed threshold
8100 stop.received Stop Received Event to indicate of the stop was physically received at the warehouse/depot location
8500 stop.returns.receive Returns Receive Confirmation Receive returns using warehouse app at Hub/DC

Appointment Scheduling Events

Event Code Name Description
8101 stop.appointment.initiated Stop Scheduling Initiated
8102 stop.appointment.confirmed Stop Scheduling Confirmed
8103 stop.appointment.canceled Stop Scheduling Cancelled

Outbound Messages Classified by Events

Events Route Header Stop Header Stop Details Multiple Stops included in message
7023
7089
7085
8500		 Yes Yes Yes Yes
7009
7068
7087
8100
7028		 No Yes Yes No
7007
7008		 No Yes No No
7114 No Yes No No

Event API

Events are triggered by actions in nuDelierIt app or portal

Event messages contain event information pertaining to the trigger action.

Authorizations:
basicAuth
path Parameters
webhookUrl
required
string

webhook URL supplied by client

Request Body schema: application/json

event message

eventCode
required
string

Event codes (numeric) as described in the event list. [maxLength - 10]

eventCodeName
string

Event code name defined in the event list. [maxLength - 50]

eventName
required
string

Event name defined in the event list. [maxLength - 50]

eventDTTM
required
string

Time of event in yyyy-mm-ddTHH:mm:ss

eventTz
required
string

Time zone of the event GMT or US/Eastern. [maxLength - 20]

eventLat
required
string

GPS latitude of the event. [maxLength - 10]

eventLng
required
string

GPS longitude of the event. [maxLength - 10]

eventGuid
required
string

unique GUID attached to the event. Can be used to verify if the event is a duplicate message. [maxLength - 20]

eventMsg
object (EventMsg)

describes data relative to the event such as a stop arrival will have the stop Number, customer etc.

eventData
required
object (EventData)

Event data related to the events. Note Only the nodes that are related to the event will be present (routeEvent or stopEvent)

Responses

200

OK - message received successfully

post /{webhookUrl}
https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v5/{webhookUrl}

Request samples

Content type
application/json
Example
RouteCreated
Copy
 Expand all Collapse all
{
  • "eventCode": "7000",
  • "eventName": "Route Created",
  • "eventDTTM": "2020-12-16T17:24:03Z",
  • "eventTz": "GMT",
  • "eventGuid": "11066290-ba9f-4607-b80b-970b2795fc35",
  • "eventMsg":
    {
    },
  • "eventData":
    {
    }
}

ETA

ETA of routes in-progress.

These messages can be subscribed. The ETA of the route is send every 10 minutes from its departure at the origin based on the remaining distance and time to travel

Authorizations:
basicAuth
path Parameters
webhookUrlETA
required
string

webhook URL supplied by client for ETA

Request Body schema: application/json

ETA message

loadNbr
required
string <= 20 characters

A unique business routeNbr representing the route.

latitude
required
string <= 10 characters

current location of the route GPS latitude.

longitude
required
string <= 10 characters

current location of the route GPS latitude.

reportedDTTM
required
string

GMT time when the location of the route was reported

status
required
string <= 10 characters

status of the route. 40 in-progress.

stopETAList
Array of objects (StopETA)

ETA of every stop visited by the route

Responses

200

OK - message received successfully

post /{webhookUrlETA}
https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v5/{webhookUrlETA}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "loadNbr": "LOAD000323",
  • "latitude": 34.23423,
  • "longitude": 12.2342,
  • "reportedDTTM": "2019-10-13T15:45:33.000Z",
  • "status": 40,
  • "stopETAList":
    [
    ]
}

ETA Change of routes in-progress.

These messages can be subscribed. When the ETA changes beyond a configured threshold for the route and any of the stops, this event is triggered

Authorizations:
basicAuth
path Parameters
webhookUrlETABreach
required
string

webhook URL supplied by client for ETA

Request Body schema: application/json

ETA message

eventCode
required
string <= 4 characters

EventCode of the breach event (7114)

loadNbr
required
string <= 20 characters

A unique business routeNbr representing the route.

latitude
required
string <= 10 characters

current location of the route GPS latitude.

longitude
required
string <= 10 characters

current location of the route GPS latitude.

reportedDTTM
required
string

GMT time when the location of the route was reported

status
required
string <= 10 characters

status of the route. 40 in-progress.

stopETAList
Array of objects (StopETA)

ETA of every stop visited by the route

Responses

200

OK - message received successfully

post /{webhookUrlETABreach}
https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v5/{webhookUrlETABreach}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "eventCode": "7114",
  • "loadNbr": "LOAD000323",
  • "latitude": 34.23423,
  • "longitude": 12.2342,
  • "reportedDTTM": "2019-10-13T15:45:33.000Z",
  • "status": 40,
  • "stopETAList":
    [
    ]
}