nuDeliverit
Documentation Powered by ReDoc

nuDeliverIt API (5.0)

Download OpenAPI specification:Download

License: nuVizz SaaS License

Authentication

Basic Authentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Change Log

API Change Log

Version Date Changes Comments
5.0.1 June 30th 2020 Initial Version
5.0.1 July 08th 2020 Example Updates
5.0.2 July 9th 2020 consAttribute added at Stop
5.0.2 July 16th 2020 Doc. updated with fields MaxLength
5.0.2 July 21th 2020 Fields updated with MaxLength
5.0.2 July 24th 2020 Definition updated for puConf/doConf
5.0.2 July 31th 2020 Corrected StopNr and other fields length
5.0.2 Aug 3rd 2020 Corrected criticalDimention size
5.0.3 Aug 8th 2020 Added RouteName in LoadHeader and increased phoneNumber length
5.0.3 Aug 17th 2020 Description updated for documentData
5.0.3 Aug 19th 2020 Updated CDL number length
5.0.3 Aug 24th 2020 Description updated for delayReasonCode
5.0.3 Aug 27th 2020 Updated load with min field example
5.0.4 Sep 1st 2020 Added shipForBP, shipperCode at vizzon
5.0.4 Sep 7th 2020 Updated User example
5.0.4 Sep 9th 2020 Updated Role as an array example
5.0.4 Nov 10th 2020 Updated LoadAPI example
5.0.5 Dec 15th 2020 Added ASN API
5.0.5 Dec 18th 2020 Updated Carton example
5.0.5 Dec 23th 2020 Added UserAPI example with min fields
5.0.5 Feb 2nd 2021 Added parentCompanyCode and templateCompanyCode
5.0.6 Feb 26th 2021 Added Shipfrom fields
5.0.7 Mar 08th 2021 Adding Customer order API
5.0.8 Mar 25th 2021 orderPriority field added at Order
5.0.9 Mar 25th 2021 Added worktype in LoadHeader
5.0.10 Mar 26th 2021 Added Carton Content fields at StopDetail
5.0.11 Apr 1st 2021 Added TimeZone definitions List of TimeZones
5.0.12 Apr 07th 2021 Added ShipFrom contact fields
5.0.13 Apr 08th 2021 Added ShipFrom contact fields at order
5.0.14 Apr 16th 2021 Added Customer order API example

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 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

Load API

Load information

If the Load ID exists in nuDeliverit then it will return the load info along with events.

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

nuDeliverIt Company code to which the Load belongs to

loadNbr
required
string

Unique alphanumeric value used to refer a Load

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

get /load/info/{companyCode}/{loadNbr}
https://contact-support.nuvizz.com/deliverit/openapi/load/info/{companyCode}/{loadNbr}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Load":
    {
    }
}

Load import

Imports the load into nuDeliverit in asynchronous mode.

Authorizations:
Basic Authentication
path Parameters
serviceName
required
string

serviceName refer to custom integration for the company, set to "default" if not using a custom integration

companyCode
required
string

Code of the nuDeliverIt Company to which the Load belongs to

Request Body schema: application/json

importRequest

companyCode
required
string

CompanyCode from nudeliverit application

loads
required
Array of objects (Loads)

Responses

200

OK

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

500

Internal server error

post /load/update/{serviceName}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/load/update/{serviceName}/{companyCode}

Request samples

Content type
application/json
Example
Package
Copy
 Expand all Collapse all
{
  • "companyCode": "XYZ",
  • "loads":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Assign Load to a Carrier

Assign a Load to a Carrier/Bussiness Partner by specifying the CarrierCode of the carrier.

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Refers to the code of the nuDeliverIt company to which the Load belongs to

loadNbr
required
string

Unique alpha numeric value used to refer a Load

Request Body schema: application/json

importRequest

carrierCode
required
string <= 10 characters

Load assigned carrier code.

assignmentCriteria
string <= 10 characters

It has a value 01 and when given so will look for the corresponding carrier code and assign the Load to available driver of that carrier.

Responses

200

OK

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

500

Internal server error

post /load/assign/carrier/{loadNbr}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/load/assign/carrier/{loadNbr}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Unassign Load from a carrier

Unassign a Load from the Carrier/BusinessPartner

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Load belongs to

loadNbr
required
string

Unique alpha numeric value used to refer a Load

Request Body schema: application/json

importRequest

carrierCode
required
string <= 10 characters

Load assigned carrier code.

assignmentCriteria
string <= 10 characters

It has a value 01 and when given so will look for the corresponding carrier code and assign the Load to available driver of that carrier.

Responses

200

OK

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

500

Internal server error

post /load/unassign/carrier/{loadNbr}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/load/unassign/carrier/{loadNbr}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Assign Load to a Driver

Assign a Load to a driver

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Load belongs to

loadNbr
required
string

Unique alpha numeric value used to refer a Load

Request Body schema: application/json

importRequest

driverEmail
string <= 50 characters

Email ID of Driver assigned.

driverName
string <= 50 characters

Refers to First and Last names of Driver.

assignmentCriteria
string <= 10 characters

Load assignment criteria when set as 01 will look for available driver and assign Load to that driver.

driverCdl
string <= 10 characters

Load assigned driver licence.

driverUserName
string <= 50 characters

Refers to Driver User Name in nudeliverit.

Responses

200

OK

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

500

Internal server error

post /load/assign/driver/{loadNbr}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/load/assign/driver/{loadNbr}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "driverEmail": "driver1@test.com",
  • "driverName": "John Smith",
  • "assignmentCriteria": "01",
  • "driverCdl": 98724890,
  • "driverUserName": "JohnSmith"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Unassign Load to a Driver

Unassigning a a Load from a Driver

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Load belongs to

loadNbr
required
string

Unique alpha numeric value used to refer a Load

Request Body schema: application/json

importRequest

driverEmail
string <= 50 characters

Email ID of Driver assigned.

driverName
string <= 50 characters

Refers to First and Last names of Driver.

assignmentCriteria
string <= 10 characters

Load assignment criteria when set as 01 will look for available driver and assign Load to that driver.

driverCdl
string <= 10 characters

Load assigned driver licence.

driverUserName
string <= 50 characters

Refers to Driver User Name in nudeliverit.

Responses

200

OK

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

500

Internal server error

post /load/unassign/driver/{loadNbr}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/load/unassign/driver/{loadNbr}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "driverEmail": "driver1@test.com",
  • "driverName": "John Smith",
  • "assignmentCriteria": "01",
  • "driverCdl": 98724890,
  • "driverUserName": "JohnSmith"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Cancel Load

Delete/Reject a Load that is unassigned from a Driver and move it to cancelled status

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Load belongs to

Request Body schema: application/json
loadNbr
required
string <= 20 characters

Unique alphanumeric value that refers to a Load.

reasonCode
required
string <= 10 characters

reasonCode is nudeliverit system code that refers to a particular reaon for canceling the Load.

reasonComments
string <= 500 characters

Comments included when canceling the Load.

Responses

200

OK

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

500

Internal server error

post /load/cancel/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/load/cancel/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "loadNbr": "L1230001",
  • "reasonCode": "01",
  • "reasonComments": "Duplicated orders on this Load"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Stop API

Stop information

Details of a Stop/Order which is usually the product name, quantity, capacity constraints etc.

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

stopNbr
required
string

Unique alpha numeric value used to refer a Stop/Order

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

get /stop/info/{companyCode}/{stopNbr}
https://contact-support.nuvizz.com/deliverit/openapi/stop/info/{companyCode}/{stopNbr}

Response samples

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

Stop import

Import a Stop/Order for a certain nuDeliverItCompany

Authorizations:
Basic Authentication
path Parameters
serviceName
required
string

serviceName refer to custom integration for the company, set to "default" if not using a custom integration

companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

Code of a nudeliverit Company to which the Stop belongs to.

stops
required
Array of objects (Stops)

Responses

200

OK

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

500

Internal server error

post /stop/update/{serviceName}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/stop/update/{serviceName}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "companyCode": "XYZ,",
  • "stops":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Assign Stop to a Carrier

Assign a Stop to a Business Partner/Carrier using Carrier Code

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

stopNbr
required
string

Unique alpha numeric value that refers to a Stop/Order

Request Body schema: application/json

importRequest

carrierCode
required
string <= 10 characters

Load assigned carrier code.

assignmentCriteria
string <= 10 characters

It has a value 01 and when given so will look for the corresponding carrier code and assign the Load to available driver of that carrier.

Responses

200

OK

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

500

Internal server error

post /stop/assign/carrier/{stopNbr}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/stop/assign/carrier/{stopNbr}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Unassign Stop to a carrier

Unassign a Stop from a Carrier/Business Partner(Previously assigned to a Carrier)

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

stopNbr
required
string

Unique alpha numeric value that refers to a Stop/Order

Request Body schema: application/json

importRequest

carrierCode
required
string <= 10 characters

Load assigned carrier code.

assignmentCriteria
string <= 10 characters

It has a value 01 and when given so will look for the corresponding carrier code and assign the Load to available driver of that carrier.

Responses

200

OK

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

500

Internal server error

post /stop/unassign/carrier/{stopNbr}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/stop/unassign/carrier/{stopNbr}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Cancel Stop

Delete/Reject a stop(in unplanned, created statuses)

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop/Order belongs to

Request Body schema: application/json
stopNbr
required
string <= 20 characters

Unique alpha numeric value that refers to a Stop.

reasonCode
required
string <= 10 characters

Code that refers to the particular nuDeliverit system code for canceling a Stop.

reasonComments
string <= 500 characters

Comments entered during the cancellation of a stop/order.

Responses

200

OK

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

500

Internal server error

post /stop/cancel/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/stop/cancel/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "stopNbr": "S10001112",
  • "reasonCode": "01",
  • "reasonComments": "In-valid Stop details"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Customer Order API

Customer Order information

Customer Order API is used to create a request to transport goods from a customer pickup location to a drop off location. Depending on the geographic locations, cross dock facilities involved in moving the goods can be provided to generate multiple shipments tied to the customer order.

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

orderNbr
required
string

Unique alpha numeric value used to refer a Order

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

get /order/info/{companyCode}/{orderNbr}
https://contact-support.nuvizz.com/deliverit/openapi/order/info/{companyCode}/{orderNbr}

Response samples

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

Customer Order import

Import a Order for a certain nuDeliverItCompany

Authorizations:
Basic Authentication
path Parameters
serviceName
required
string

serviceName refer to custom integration for the company, set to "default" if not using a custom integration

companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

Code of a nudeliverit Company to which the Order belongs to.

orders
required
Array of objects (Orders)

Responses

200

OK

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

500

Internal server error

post /order/update/{serviceName}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/order/update/{serviceName}/{companyCode}

Request samples

Content type
application/json
Example
Pickup - Drop off
Copy
 Expand all Collapse all
{
  • "companyCode": "XYZ",
  • "orders":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Cancel Customer Order

Delete/Reject a stop(in unplanned, created statuses)

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop/Order belongs to

Request Body schema: application/json
orderNbr
required
string <= 20 characters

Unique alpha numeric value that refers to a Order.

reasonCode
required
string <= 10 characters

Code that refers to the particular nuDeliverit system code for canceling a order.

reasonComments
string <= 500 characters

Comments entered during the cancellation of a stop/order.

Responses

200

OK

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

500

Internal server error

post /order/cancel/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/order/cancel/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderNbr": "S10001112",
  • "reasonCode": "01",
  • "reasonComments": "In-valid Stop details"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

ASN API

ASN import

Import a advanced shipment notice (ASN)

Authorizations:
Basic Authentication
path Parameters
serviceName
required
string

serviceName refer to custom integration for the company, set to "default" if not using a custom integration

companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

Code of a nudeliverit Company to which the Stop belongs to.

stops
required
Array of objects (Stops)

Responses

200

OK

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

500

Internal server error

post /asn/update/{serviceName}/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/asn/update/{serviceName}/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "companyCode": "XYZ",
  • "stops":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Cancel ASN

Delete/Reject a ASN(InboundShipment status)

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop/Order belongs to

Request Body schema: application/json
stopNbr
required
string <= 20 characters

Unique alpha numeric value that refers to a Stop.

reasonCode
required
string <= 10 characters

Code that refers to the particular nuDeliverit system code for canceling a Stop.

reasonComments
string <= 500 characters

Comments entered during the cancellation of a stop/order.

Responses

200

OK

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

500

Internal server error

post /asn/cancel/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/asn/cancel/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "stopNbr": "S10001112",
  • "reasonCode": "01",
  • "reasonComments": "In-valid Stop details"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Business Partner API

Create or update business partner

Create or Update business partner

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the business partner belongs to

Request Body schema: application/json
companyCode
required
string <= 10 characters

Code of a nudeliverit Company to which the Business parter belongs to.

businessPartners
Array of objects (BusinessPartners)

Responses

200

OK

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

500

Internal server error

post /businesspartner/update/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/businesspartner/update/{companyCode}

Request samples

Content type
application/json
Example
Only BusinessPartner
Copy
 Expand all Collapse all
{
  • "companyCode": "XYZ",
  • "businessPartners":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

User API

Create user

The nuDeliverIt User API, partners will be able to create users on the nuDeliverIt portal.

User Roles Comments
MemberAdmin This is a super admin user for a company and this user can Create new users Access to all admin functions within the system. User rights include Create/enable/disable new/existing users. Able to create/edit/update new filters, reports, and dashboards. No access to nuDeliverIt driver app
DI_Receiver With this role, the user will be able to login to the nuDeliverIt warehouse app and perform the action like Receive cartons Load returns
DI_Integration This is the Integration user role and can, Upload and interface load data into the nuDeliverIt system. Restricted/limited access to nuDeliverIt portal screens. No access to nuDeliverIt driver app. Cannot create/update new/existing users on nuDeliverIt platform
DI_Inquiry This is a view-only user role and the user can only have view-only access to specific nuDeliverIt portal screens,No access to nuDeliverIt driver app. For eg., the user will be able to access the various screens but will be prohibited from making any updates/changes on any of the portal screens
DI_Driver With this role, the user will be able to login to the nuDeliverIt driver app and perform the actions like, execute assigned loads/routes on the nuDeliverIt driver app (POD capture etc). No access to the nuDeliverIt portal. No edits/updates can be done to the loads assigned for execution on the app with this role
DI_Dispatcher The user can Login to the nuDeliverIt portal with the credentials provided. User access include create/enable/disable new/existing users. Perform all dispatcher functions required on the nuDeliverIt portal like create/edit/update loads/stops, assign /unassign drivers and carriers Restrictions included when creating/editing filters, reports, and dashboards. No access to nuDeliverIt driver app
Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the user belongs to

Request Body schema: application/json
companyCode
required
string <= 10 characters

Code of a nudeliverit Company to which the User belongs to.

users
required
Array of objects (Users)

Responses

200

OK

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

500

Internal server error

post /user/update/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/user/update/{companyCode}

Request samples

Content type
application/json
Example
default User API
Copy
 Expand all Collapse all
{
  • "companyCode": "001Test",
  • "users":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "Success"
}

Appointment

Appointment/ Capacity Planning

This API provides a list of available appointment/ service capacities. Given the an address and an optional order#, a list of available timeslots are sent back in the response. A subsequent API for reservation can be performed to reserve a time slot.

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company

Request Body schema: application/json

Appointment request

apptRequest
object (Appointment request body)

Responses

200

OK

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

500

Internal server error

post /appointment/request/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/appointment/request/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apptRequest":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apptRequest":
    {
    }
}

Appointment/ Capacity Reservation

This API reserves the capacity for the Timeslot indicated. The reservation can be for an order that yet to be placed (OrderId = Not Available). The reservation is made for a temporary hold for {apptTTL} minutes.

It is necessary to indicate the capacity of the order in terms of weight/ volume/ qty/ service time. If the capacity/appt reservation does not contain any of the elements, then a reservation is not made.

The capacity reservation request can be made for an existing order as well as yet to be confirmed order.

For an existing order, the orderId must be mentioned. If the reservation request can be honored, the previous appt (if exists) will be released and the new appt will be updated directly on the order.

Authorizations:
Basic Authentication
path Parameters
companyCode
required
string

Company Code

Request Body schema: application/json

Appointment reservation request

apptReservation
object (Appointment reservation request)

Responses

200

OK

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

500

Internal server error

post /appointment/reservation/{companyCode}
https://contact-support.nuvizz.com/deliverit/openapi/appointment/reservation/{companyCode}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apptReservation":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apptReservation":
    {
    }
}