nuVizz
API docs by Redocly

nuVizz API (7.0)

Download OpenAPI specification:Download

License: nuVizz SaaS License

Change Log

API Change Log

Version Date Changes Comments
6.1.0 Jun 16, 2021 Initial Version
6.1.1 Feb 8, 2022 Updated Stop Info and Load Info API
7.0.1 Jun 15 2022 Documents can be added to Pickup and Delivery
7.0.2 Jun 27 2022 New API End point for route Plan
7.4.0 Jan 04 2023 timeConstraint default value updated to Strict

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

Customer Order API

Multi-Leg Order API provides creation on single or multiple legs of transportation from PickUp to Delivery cross-docking through multiple-hubs.

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:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

query Parameters
orderNbr
required
string

Unique alpha numeric value used to refer a Order

orderId
required
string

Unique alpha numeric value used to refer a Order

Responses

Request samples 

// Import classes:
import com.nuvizz.openapi.inbound.handler.ApiClient;
import com.nuvizz.openapi.inbound.handler.ApiException;
import com.nuvizz.openapi.inbound.handler.Configuration;
import com.nuvizz.openapi.inbound.handler.auth.*;
import com.nuvizz.openapi.inbound.handler.models.*;
import com.nuvizz.openapi.inbound.handler.CustomerOrderApiApi;

public class Example {
public static void main(String[] args) {
  ApiClient defaultClient = Configuration.getDefaultApiClient();
  defaultClient.setBasePath("https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v6");
  
  // Configure HTTP basic authorization: Basic Authentication
  HttpBasicAuth Basic Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
  Basic Authentication.setUsername("YOUR USERNAME");
  Basic Authentication.setPassword("YOUR PASSWORD");

  CustomerOrderApiApi apiInstance = new CustomerOrderApiApi(defaultClient);
  String companyCode = "companyCode_example"; // String | Code of the nuDeliverIt Company to which the Stop belongs to
  String orderNbr = "orderNbr_example"; // String | Unique alpha numeric value used to refer a Order
  try {
    OrderSuccessResponse result = apiInstance.getOrderDetail(companyCode, orderNbr);
    System.out.println(result);
  } catch (ApiException e) {
    System.err.println("Exception when calling CustomerOrderApiApi#getOrderDetail");
    System.err.println("Status code: " + e.getCode());
    System.err.println("Reason: " + e.getResponseBody());
    System.err.println("Response headers: " + e.getResponseHeaders());
    e.printStackTrace();
  }
}
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Customer Order import

Import a Single Order

Authorizations:
BasicAuthentication
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

Company Code the order belongs

Request Body schema: application/json

Customer Order Creation/Update request

object (Create or Update a Customer Order)
Array of objects (Hubs to traverse to destination)

Required when the xDockType=MULTILEG. A more elaborate description of legs of shipment

Responses

Request samples

Content type
application/json
Example
{
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Cancel Customer Order

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

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

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

Unique alpha numeric value that refers to a Order.

orderId
string <= 64 characters

Unique alpha numeric value that refers to a Order.

reasonCode
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

Request samples

Content type
application/json
{
  • "orderNbr": "S10001112",
  • "orderId": "S10001112",
  • "reasonCode": "01",
  • "reasonComments": "In-valid Order details"
}

Response samples

Content type
application/json
{
  • "order": {
    }
}

Auth API

These APIs provide authorization info required to execute webservices.

Authorization Token to execute Webservice APIs.

This API provides Auth Token to execute webservice calls.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company

Responses

Response samples

Content type
application/json
{
  • "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5",
  • "expiresAt": 169560112
}

Public certificate for API auth token.

This API provides the certificate used by the auth Token to execute webservice calls.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company

Responses

Response samples

Content type
application/json
{
  • "cert": "MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCKAIc+hqdKgcPb9XbR5Osbdeq1J14zxRG58CkrHZO0PMSf/smoCEyEcxhGsjrITl/sLv/q8iOVMKgYKdpOMIoPDGCF8KCXA4F9hM/WXJstprEeqPi7a1FnXzi3uwaf+jy2zUviDt09jm+guu5TaZzTuzyoClEgfwIu2LwuHaJKtjceRKHWKvUqqxBQMXlq/s5lNXWajWSpLffP"
}

Order-Stop Billing

These APIs provide for Stop/Order billing information. These include

  • Estimation
  • Final Charges

Get Stop Estimate

Determine the estimation of transportation cost for a stop. This operation does not create a stop

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

Request Body schema: application/json

Stop to be estimated

required
object (Stop Information for stop estimation)

Responses

Request samples

Content type
application/json
{
  • "stop": {
    }
}

Response samples

Content type
application/json
{
  • "contractCode": "CALD923",
  • "contractId": "abcdefabcdef23248234",
  • "amount": 2203.02,
  • "rateDtls": [
    ],
  • "accessorialDtls": [
    ],
  • "fuelCharge": {
    }
}

Create Stop Estimates

Determine the estimation of transportation cost for a stop. This request creates Estimates an existing stop in the sytem. If a previous estimate is present, it overwrites that estimate. multiple stops can be estimated in the request.

This request is performed when is a stop is created via various means (API/UI/Customer Portal) and stop creation calls this process in the background.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

Request Body schema: application/json

Stops to be estimated

Array of objects (List of StopIds)

Responses

Request samples

Content type
application/json
{
  • "stops": [
    ]
}

Response samples

Content type
application/json
null

Get Billing Amts

Determine the estimation of transportation cost for a stop. This operation does not create a stop

Query params can be provided for the following groups

  1. stopId - First preference
  2. stopNbr - 2nd Preference Atleast one of the query params are required
Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

query Parameters
stopId
string

StopId of the stop being inquired

stopNbr
string

StopNbr of the stop being inquired

Responses

Response samples

Content type
application/json
{
  • "billStatus": 50,
  • "estimate": {
    },
  • "billed": {
    }
}

Doc Map API

Mapping Doc data to Stop

Import from Doc

Create stop from Doc

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Stop belongs to

query Parameters
templateName
string

Name of the Doc Mapping template to be used

Request Body schema: multipart/form-data
filename
string <binary>

Responses

Response samples

Content type
application/json
{
  • "stop": {
    },
  • "reasons": [
    ]
}

Load API

Load Information

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company code to which the Load belongs

loadNbr
required
string

Unique alphanumeric value used to refer a Load

Responses

Request samples 

// Import classes:
import com.nuvizz.openapi.inbound.handler.ApiClient;
import com.nuvizz.openapi.inbound.handler.ApiException;
import com.nuvizz.openapi.inbound.handler.Configuration;
import com.nuvizz.openapi.inbound.handler.auth.*;
import com.nuvizz.openapi.inbound.handler.models.*;
import com.nuvizz.openapi.inbound.handler.LoadApiApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v5");

   // Configure HTTP basic authorization: Basic Authentication
  HttpBasicAuth Basic Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
  Basic Authentication.setUsername("YOUR USERNAME");
  Basic Authentication.setPassword("YOUR PASSWORD");

  LoadApiApi apiInstance = new LoadApiApi(defaultClient);
  String companyCode = "companyCode_example"; // String | Company code to which the Load belongs to
  String loadNbr = "loadNbr_example"; // String | Unique alphanumeric value used to refer a Load
  try {
    LoadInfoSuccessResponse result = apiInstance.getLoadDetail(companyCode, loadNbr);
    System.out.println(result);
  } catch (ApiException e) {
    System.err.println("Exception when calling LoadApiApi#getLoadDetail");
    System.err.println("Status code: " + e.getCode());
    System.err.println("Reason: " + e.getResponseBody());
    System.err.println("Response headers: " + e.getResponseHeaders());
    e.printStackTrace();
    }
  }
}

Response samples

Content type
application/json
{
  • "Load": {
    }
}

Load import

Imports the load in asynchronous mode.

Authorizations:
BasicAuthentication
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

Company Code to which the Load belongs to

Request Body schema: application/json

importRequest

companyCode
required
string

CompanyCode from application

required
Array of objects (Loads)

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "XYZ",
  • "loads": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Recurring Route Import

Creates a recurring route from an existing route in the system in synchronous mode.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code to which the route belongs

Request Body schema: application/json

importRequest

companyCode
required
string

Company Code from the nuVizz application.

routeId
string

Unique alphanumeric system generated id used to refer to a route.

routeNbr
required
string <= 20 characters

The route number unique to the business. Represents a truck load.

routeName
required
string <= 20 characters

The route name following the movement of goods.

daysOfWeek
required
string <= 7 characters

List of days of week for preferred delivery

  • M Monday
  • T Tuesday
  • W Wednesday
  • R Thursday
  • F Friday
  • S Saturday
  • U Sunday
overrideExisting
required
boolean

Override an existing recurring route of the same name

Responses

Request samples

Content type
application/json
{
  • "companyCode": "1181",
  • "routeNbr": "W59-NUDEL012944",
  • "routeName": "W-59MONDAY",
  • "daysOfWeek": "MW",
  • "overrideExisting": true
}

Response samples

Content type
application/json
{
  • "reasons": [
    ]
}

Assign Load to a Carrier

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code to which the Load belongs

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

Request samples

Content type
application/json
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Unassign Load from a carrier

Unassign a Load from the Carrier/BusinessPartner

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of the Load/Route Owner

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

Request samples

Content type
application/json
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Assign Load to a Driver

Assign a Load to a driver

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Load/Route

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.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Unassign Load to a Driver

Unassigning a a Load from a Driver

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Load/Route

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.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Cancel Load

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Load/Route

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 the system code that refers to a particular reaon for canceling the Load.

reasonComments
string <= 500 characters

Comments included when canceling the Load.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Stop API

Stop Information

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

stopNbr
required
string

Unique alpha numeric value used to refer a Stop/Order

Responses

Request samples 

// Import classes:
import com.nuvizz.openapi.inbound.handler.ApiClient;
import com.nuvizz.openapi.inbound.handler.ApiException;
import com.nuvizz.openapi.inbound.handler.Configuration;
import com.nuvizz.openapi.inbound.handler.auth.*;
import com.nuvizz.openapi.inbound.handler.models.*;
import com.nuvizz.openapi.inbound.handler.LoadApiApi;

  public class Example {
   public static void main(String[] args) {
   ApiClient defaultClient = Configuration.getDefaultApiClient();
   defaultClient.setBasePath("https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v5");

    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth Basic Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    Basic Authentication.setUsername("YOUR USERNAME");
    Basic Authentication.setPassword("YOUR PASSWORD");

     StopApiApi apiInstance = new StopApiApi(defaultClient);
     String companyCode = "companyCode_example"; // String | Company Code of Stop
     String stopNbr = "stopNbr_example"; // String | Unique alpha numeric value used to refer a Stop/Order
    try {
       StopInfoSuccessResponse result = apiInstance.getStopDetail(companyCode, stopNbr);
       System.out.println(result);
       } catch (ApiException e) {
        System.err.println("Exception when calling StopApiApi#getStopDetail");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
         e.printStackTrace();
        }
       }
      }

Response samples

Content type
application/json
{
  • "Stop": {
    }
}

Stop Info By Id

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code which the Stop/Order belongs to.

query Parameters
stopId
required
string

Unique alpha numeric system generated id used to refer a Stop/Order

Responses

Response samples

Content type
application/json
{
  • "stop": {
    },
  • "reasons": [
    ]
}

Stop Info By ShipmentNbr

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code which the shipment belongs to.

query Parameters
shipmentNbr
required
string

Alpha numeric value used to refer a shipment.

zipCode
required
string

zip code of ship to address of stop/order.

fromDTTM
required
string

Scheduled date and time in local format yyyy-MM-ddTHH:mm:ss.

toDTTM
required
string

Earliest Scheduled date and time in local format yyyy-MM-ddTHH:mm:ss.

Responses

Response samples

Content type
application/json
{
  • "stops": [
    ],
  • "reasons": [
    ]
}

PU & DO ETA Information

Return the pickup and delivery ETA Details of Stop/Order.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code which the Stop/Order belongs to.

query Parameters
stopNbr
string

Unique alpha numeric value used to refer a Stop/Order.

stopId
string

Unique alpha numeric system generated id used to refer a Stop/Order.

Note: In query parameters either stopId or stopNbr is mandatory.

Responses

Response samples

Content type
application/json
{
  • "pickupETA": [
    ],
  • "deliveryETA": [
    ]
}

ETA Information

Return the ETA Details of Stop/Order.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code which the Stop/Order belongs to.

query Parameters
stopNbr
string

Unique alpha numeric value used to refer a Stop/Order.

stopId
string

Unique alpha numeric system generated id used to refer a Stop/Order.

Note: In query parameters either stopId or stopNbr is mandatory.

Responses

Response samples

Content type
application/json
{
  • "etaDTTM": "2023-07-24T07:19:00",
  • "earliestEtaDTTM": "2023-07-24T07:49:00",
  • "latestEtaDTTM": "2023-07-24T08:19:00",
  • "etaWindow": 30
}

Event Information

Return the event information of Stop/Order.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code which the Stop/Order belongs to.

query Parameters
stopNbr
string

Unique alpha numeric value used to refer a Stop/Order.

stopId
string

Unique alpha numeric system generated id used to refer a Stop/Order.

Note: In query parameters either stopId or stopNbr is mandatory.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Stop import

Import a Stop/Order for a certain Company

Authorizations:
BasicAuthentication
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

Company Code of Stop

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

Company Code of Stop.

required
Array of objects (Stops)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Stop import (Synchronous)

Import a Stop/Order for a certain Company

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

Company Code of Stop.

required
object (Stop)

Responses

Request samples

Content type
application/json
{
  • "companyCode": "XYZ,",
  • "stop": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Assign Stop to a Carrier

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

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

Request samples

Content type
application/json
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Assign Stop to a Business Partner/Carrier

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

Request Body schema: application/json

importRequest

stopNbr
string

Unique alpha numeric value used to refer a Stop/Order.

stopId
string

Unique alpha numeric system generated id used to refer a Stop/Order

Note: In query parameters either stopNbr or stopId is mandatory.

bpId
integer

Business Partner Id to which the stop has to be assigned.

carrierCode
string <= 10 characters

Carrier code to which the stop has to be assigned.

Note: In query parameters either bpId or carrierCode is mandatory.

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

Request samples

Content type
application/json
{
  • "stopNbr": "S10001112",
  • "stopId": "string",
  • "bpId": 12345,
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Unassign Stop to a carrier

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

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

Request samples

Content type
application/json
{
  • "carrierCode": "XYZBP",
  • "assignmentCriteria": "01"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Cancel Stop

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

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

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

Unique alpha numeric value that refers to a Stop.

stopId
string

Unique alpha numeric system generated id used to refer a Stop/Order

Note: In query parameters either stopNbr or stopId is mandatory.

reasonCode
required
string <= 10 characters

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

reasonComments
string <= 500 characters

Comments entered during the cancellation of a stop/order.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

ASN API

ASN import

Import a advanced shipment notice (ASN)

Authorizations:
BasicAuthentication
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

Company Code of Stop

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

Company Code of Stop.

required
Array of objects (Stops)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Cancel ASN

Delete/Reject a ASN(InboundShipment status)

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop

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

Unique alpha numeric value that refers to a Stop.

stopId
string

Unique alpha numeric system generated id used to refer a Stop/Order

Note: In query parameters either stopNbr or stopId is mandatory.

reasonCode
required
string <= 10 characters

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

reasonComments
string <= 500 characters

Comments entered during the cancellation of a stop/order.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Stop Template API

Stop Template Information

Lists the stop templates belonging to the company code. If name is provided, template of that name belonging to the company code will be listed.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of StopTemplate

query Parameters
name
string

Unique name for this StopTemplate. If Id is provided, id takes precedence Either id or name must be provided.

id
string

Unique internal Id of StopTemplate. ID takes precedence over name

type
string

Template type can be either TEMP_STOP or ORD_PROF.

Responses

Response samples

Content type
application/json
{
  • "stopTemplates": [
    ]
}

Stop Template Information with Pagination

Lists the stop templates belonging to the company code. If name is provided, template of that name belonging to the company code will be listed.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of StopTemplate

Request Body schema: application/json
pageSize
required
number

Page size determined by the application.

page
required
number

The current page number being queried.

maxResult
required
number

Maximum number of records per page.

Responses

Request samples

Content type
application/json
{
  • "pageSize": 20,
  • "page": 1,
  • "maxResult": 20
}

Response samples

Content type
application/json
{
  • "totalRecords": 81,
  • "defaultSize": 20,
  • "currentPageSize": 1,
  • "pageNo": 5,
  • "stopTemplates": [
    ]
}

Stop Template import

Import a Stop Template for a certain Company

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of Stop Template

Request Body schema: application/json

importRequest

id
string

Internal ID of StopTemplate Used for Delete or updates. For create requests, do not send this element

companyCode
required
string

Company code of the template

name
required
string

Name of the template

object (RecurringSchedule)

Recurring Schedule information

required
object (StopTemplate)

Stop Template

Responses

Request samples

Content type
application/json
{
  • "id": "abcdefabcdef0002020",
  • "companyCode": "ABC",
  • "name": "templateName",
  • "recurs": {
    },
  • "stopTemplate": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Cancel Stop Template

Cancel a stopTemplate

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code of StopTemplate

query Parameters
name
string

Unique name for this StopTemplate. If Id is provided, id takes precedence Either id or name must be provided.

id
string

Unique internal Id of StopTemplate. ID takes precedence over name

Responses

Response samples

Content type
application/json
{
  • "status": "Success"
}

Business Partner API

Create or update business partner

Create or Update business partner

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Company Code for which Business Partner is created

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

CompanyCode to which the Business parter belongs

Array of objects (BusinessPartners)

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "XYZ",
  • "businessPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

User API

Create Users

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

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 driver app
DI_Receiver With this role, the user will be able to login to the nuStockIt 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 system. Restricted/limited access to portal screens. No access to driver app. Cannot create/update new/existing users on platform
DI_Inquiry This is a view-only user role and the user can only have view-only access to specific portal screens,No access to 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 driver app and perform the actions like, execute assigned loads/routes on the driver app (POD capture etc). No access to the 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 portal with the credentials provided. User access include create/enable/disable new/existing users. Perform all dispatcher functions required on the portal like create/edit/update loads/stops, assign /unassign drivers and carriers Restrictions included when creating/editing filters, reports, and dashboards. No access to driver app
Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

CompanyCode to which the user belongs

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

CompanyCode to which the User belongs

required
Array of objects (Users)

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "001Test",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Create User (Synchronous)

With the User API, partners will be able to create, modify and disable users on the system.

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 driver app
DI_Receiver With this role, the user will be able to login to the nuStockIt 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 system. Restricted/limited access to portal screens. No access to driver app. Cannot create/update new/existing users on platform
DI_Inquiry This is a view-only user role and the user can only have view-only access to specific portal screens,No access to 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 driver app and perform the actions like, execute assigned loads/routes on the driver app (POD capture etc). No access to the 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 portal with the credentials provided. User access include create/enable/disable new/existing users. Perform all dispatcher functions required on the portal like create/edit/update loads/stops, assign /unassign drivers and carriers Restrictions included when creating/editing filters, reports, and dashboards. No access to driver app
Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

CompanyCode to which the user belongs

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

CompanyCode to which the User belongs

required
Array of objects (Users)

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "001Test",
  • "users": [
    ]
}

Response samples

Content type
application/json
null

User List

With the User API, partners will be retreive a list of users on the system. operationId: userList

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

CompanyCode to which the user belongs

Request Body schema: application/json
customerRefId
string

Unique alpha numeric value used to refer a Customer for which the user is associated with

customerAccNbr
string

Account Number of the customer

object (List Request)

Responses

Request samples

Content type
application/json
{
  • "customerRefId": "abcdef123456",
  • "pageInfo": {
    }
}

Response samples

Content type
application/json
{
  • "totalRecords": 81,
  • "defaultSize": 20,
  • "currentPageSize": 1,
  • "pageNo": 5,
  • "users": [
    ]
}

User Profile

Partners will retreive the profile of a user on the system. operationId: userInfo

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

CompanyCode to which the user belongs

query Parameters
userName
required
string

Unique username of the user to be retrieved

Responses

Request samples 

// Import classes:
import io.swagger.client.ApiClient;
import io.swagger.client.ApiException;
import io.swagger.client.Configuration;
import io.swagger.client.auth.*;
import io.swagger.client.api.UserApiApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth Basic Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
Basic Authentication.setUsername("YOUR USERNAME");
Basic Authentication.setPassword("YOUR PASSWORD");

UserApiApi apiInstance = new UserApiApi();
String companyCode = "ABC"; // String | CompanyCode to which the user belongs
try {
    UserListResponse result = apiInstance.userInfo(companyCode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApiApi#userList");
    e.printStackTrace();
}

Response samples

Content type
application/json
{
  • "userId": 123,
  • "firstName": "Test",
  • "lastName": "Bond",
  • "middleName": "Neo",
  • "userName": "TestUser",
  • "password": "abc123",
  • "gender": "Male",
  • "dob": "2001-12-31T12:00:00",
  • "email": "dr1231@nuvizz.com",
  • "customerRefId": "abcdef123456",
  • "userType": "CUSTOMER",
  • "cdlNumber": 5112747890,
  • "passwordNeverExpires": false,
  • "forcePwdChg": false,
  • "address1": "665 Washington Way",
  • "address2": "Liberty Drive",
  • "city": "Cumming",
  • "state": "GA",
  • "zip": "30080",
  • "country": "USA",
  • "accountNumber": "56A31D",
  • "assignedGroups": "memberadmin",
  • "assignmentType": 1,
  • "enabled": true,
  • "unableToUseApp": true,
  • "licenseAuthority": "DMV",
  • "licenseExpirationDttm": "2001-12-31T12:00:00",
  • "licenseState": "Georgia",
  • "phoneNumber": 4048621577,
  • "smsNumber": 4048621577,
  • "userKey": "Client assign key",
  • "profilePic": "Base64 png image",
  • "userRoles": [
    ],
  • "ref1": "UR1001",
  • "ref2": "UR1002",
  • "ref3": "UR1003",
  • "accountLocked": false,
  • "lastUpdateDTTM": "2020-04-21T12:00:00",
  • "sendInvite": false,
  • "sendReInvite": false
}

Enable/Disable User

This request will update the status of the User operationId: updateStatus

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

CompanyCode to which the user belongs

Request Body schema: application/json

importRequest

userName
required
string <= 50 characters

Login user name.

enabled
required
boolean

User status is true or false

Responses

Request samples

Content type
application/json
{
  • "userName": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Route Plan API

Create or Update Route Plan

This API is used when external systems perform Route Planning and send the route info to be updated. Route Plan enables external route planning tools to integrate their route plans into the system. Existing stops are planned or un-planned

Authorizations:
BasicAuthentication
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

Company Code to which the Route belongs to

Request Body schema: application/json
companyCode
required
string

CompanyCode from application

required
object (Route)

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "XYZ",
  • "route": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Appointment

Get available appointment

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:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the appointment slots belongs to

Request Body schema: application/json

Get available appointment slots request

stopId
string <= 50 characters

Unique alpha numeric system generated id for the order. Required only when placing a change/update to an existing order (stopNbr) in the system

stopNbr
string <= 20 characters

Unique alpha numeric value that refers to a Stop.

apptStartDate
string

Appointment Start Date yyyy-mm-dd format

object (Appointment order info)

Responses

Request samples

Content type
application/json
{
  • "stopNbr": "ORDER0001",
  • "stopId": "abcd123340707",
  • "apptStartDate": "2023-09-25",
  • "stopInfo": {
    }
}

Response samples

Content type
application/json
{
  • "stopNbr": "ORDER0001",
  • "stopId": "abcd123340707",
  • "stopInfo": {
    },
  • "serviceRegion": "eastzone",
  • "apptSlots": [
    ]
}

Set appointment

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.

RequestBody can be provided for the following groups and Atleast one of the field is required

  1. stopId - First preference
  2. stopInfo - Second preference

RequestBody can be provided for the following groups and Atleast one of the field is required

  1. timeslotId
  2. apptId
Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the appointment slots belongs to

Request Body schema: application/json

Set appointment request

timeSlotId
string

Unique ID define in nudeliverit,This id is provided in Get Available Appointment request. Required either timeSlotId or apptId. Mandatory, for the Set Appointment request, which is reservation or confirmation (internal to nuDeliverit) request

stopId
string <= 50 characters

Unique ID define in nudeliverit for the Stop. Required only when placing a change/update to an existing Stop (stopNbr) in the system

stopNbr
string <= 20 characters

Unique alpha numeric value that refers to a Stop.

apptId
string <= 50 characters

Unique ID define in nudeliverit for the appointment. This field for nuDeliverit internal purpose. Required to confirm appointment slot, after Stop create or update

apptStartDate
string

Appointment Start Date yyyy-mm-dd format

comment
string <= 200 characters

Comments provided during the appointment scheduling.

object (Appointment order info)

Responses

Request samples

Content type
application/json
{
  • "timeSlotId": "123",
  • "stopNbr": "ORDER0001",
  • "stopId": "abcd123340707",
  • "apptStartDate": "2023-09-25",
  • "stopInfo": {
    }
}

Response samples

Content type
application/json
{
  • "stopNbr": "ORDER0001",
  • "stopId": "abcd123340707",
  • "apptStatus": "ONHOLD",
  • "apptTTL": 15,
  • "apptId": "12345",
  • "serviceRegion": "eastzone",
  • "stopInfo": {
    }
}

Cancel appointment

This API cancels appointment for order. RequestBody can be provided for the following groups and Atleast one of the field is required

  1. stopIds - First preference
  2. stopNbrs - Second preference
Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the appointment belongs to

Request Body schema: application/json

Cancel appointment request

stopIds
Array of strings

List of unique alpha numeric system generated ids for stops.

stopNbrs
Array of strings

List of unique alpha numeric values that refers to stops.

comment
string <= 200 characters

Comments provided during cancelling appointment scheduling.

Responses

Request samples

Content type
application/json
{
  • "stopIds": [
    ],
  • "stopNbrs": [
    ],
  • "comment": "Not available"
}

Response samples

Content type
application/json
null

Trigger customer appointment schedule

This API is used to trigger SMS to customer for scheduling appointment. RequestBody can be provided for the following groups and Atleast one of the field is required

  1. stopIds - First preference
  2. stopNbrs - Second preference
Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

NuDeliverIt Company code.

Request Body schema: application/json

Trigger customer appointment Request

stopIds
Array of strings

List of unique alpha numeric system generated ids for stops.

stopNbrs
Array of strings

List of unique alpha numeric values that refers to stops.

Responses

Request samples

Content type
application/json
{
  • "stopIds": [
    ],
  • "stopNbrs": [
    ]
}

Response samples

Content type
application/json
null

Deprecated 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:
BasicAuthentication
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

Request samples 

// Import classes:
import com.nuvizz.openapi.inbound.handler.ApiClient;
import com.nuvizz.openapi.inbound.handler.ApiException;
import com.nuvizz.openapi.inbound.handler.Configuration;
import com.nuvizz.openapi.inbound.handler.auth.*;
import com.nuvizz.openapi.inbound.handler.models.*;
import com.nuvizz.openapi.inbound.handler.CustomerOrderApiApi;

public class Example {
public static void main(String[] args) {
  ApiClient defaultClient = Configuration.getDefaultApiClient();
  defaultClient.setBasePath("https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v6");
  
  // Configure HTTP basic authorization: Basic Authentication
  HttpBasicAuth Basic Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
  Basic Authentication.setUsername("YOUR USERNAME");
  Basic Authentication.setPassword("YOUR PASSWORD");

  CustomerOrderApiApi apiInstance = new CustomerOrderApiApi(defaultClient);
  String companyCode = "companyCode_example"; // String | Code of the nuDeliverIt Company to which the Stop belongs to
  String orderNbr = "orderNbr_example"; // String | Unique alpha numeric value used to refer a Order
  try {
    OrderSuccessResponse result = apiInstance.getOrderDetail(companyCode, orderNbr);
    System.out.println(result);
  } catch (ApiException e) {
    System.err.println("Exception when calling CustomerOrderApiApi#getOrderDetail");
    System.err.println("Status code: " + e.getCode());
    System.err.println("Reason: " + e.getResponseBody());
    System.err.println("Response headers: " + e.getResponseHeaders());
    e.printStackTrace();
  }
}
}

Response samples

Content type
application/json
{
  • "Order": [
    ]
}

Customer Order import

Import a Order for a certain nuDeliverItCompany

Authorizations:
BasicAuthentication
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.

required
Array of objects (Orders)

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "XYZ",
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Cancel Customer Order

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

Authorizations:
BasicAuthentication
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

Request samples

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

Response samples

Content type
application/json
{
  • "status": "Success"
}

Customer API

Customer information

Customer API is used to create a request to retreive customer information. Customers represent the shipper who will be providing orders to the carriers.

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Customer belongs to

accountNumber
required
string

Unique alpha numeric value used to refer a Customer

Responses

Request samples 

// Import classes:
import com.nuvizz.openapi.inbound.handler.ApiClient;
import com.nuvizz.openapi.inbound.handler.ApiException;
import com.nuvizz.openapi.inbound.handler.Configuration;
import com.nuvizz.openapi.inbound.handler.auth.*;
import com.nuvizz.openapi.inbound.handler.models.*;
import com.nuvizz.openapi.inbound.handler.CustomerApiApi;

public class Example {
public static void main(String[] args) {
  ApiClient defaultClient = Configuration.getDefaultApiClient();
  defaultClient.setBasePath("https://contact-support.nuvizz.com/api-gateway/webservices/nudeliverit/v6");
  
  // Configure HTTP basic authorization: Basic Authentication
  HttpBasicAuth Basic Authentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
  Basic Authentication.setUsername("YOUR USERNAME");
  Basic Authentication.setPassword("YOUR PASSWORD");

  CustomerApiApi apiInstance = new CustomerApiApi(defaultClient);
  String companyCode = "companyCode_example"; // String | Code of the nuDeliverIt Company to which the Customer belongs to
  String accountNumber = "accountNumber_example"; // String | Unique alpha numeric value used to refer a Customer
  try {
    CustomerSuccessResponse result = apiInstance.getCustomerDetail(companyCode, accountNumber);
    System.out.println(result);
  } catch (ApiException e) {
    System.err.println("Exception when calling CustomerApiApi#getCustomerDetail");
    System.err.println("Status code: " + e.getCode());
    System.err.println("Reason: " + e.getResponseBody());
    System.err.println("Response headers: " + e.getResponseHeaders());
    e.printStackTrace();
  }
}
}

Response samples

Content type
application/json
{
  • "Customer": [
    ]
}

Customer import

Import a Customer for a certain nuDeliverItCompany

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Customer belongs to

Request Body schema: application/json

importRequest

companyCode
required
string <= 10 characters

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

required
Array of objects (Customers)

Responses

Request samples

Content type
application/json
{
  • "companyCode": "XYZ",
  • "customers": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Customer Address List

List customer addresses for a certain nuDeliverItCompany

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Customer belongs to

accountNbr
required
string

Account Number of the customer

Request Body schema: application/json

APIRequest

pageSize
required
number

Page size determinied by the application.

page
required
number

The current page number being queried.

maxResult
required
number

Maximum number of records per page.

Responses

Request samples

Content type
application/json
{
  • "pageSize": 20,
  • "page": 1,
  • "maxResult": 20
}

Response samples

Content type
application/json
{
  • "totalRecords": 81,
  • "defaultSize": 20,
  • "currentPageSize": 1,
  • "pageNo": 5,
  • "addresses": [
    ]
}

Customer Address Update

Create or Update an address for a Customer for a certain nuDeliverItCompany

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Customer belongs to

Request Body schema: application/json

APIRequest

accountNumber
required
string <= 20 characters

Unique alpha numeric value used to refer a Customer.

required
object (AddressDetail)

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "ACC_123",
  • "customerAddress": {
    }
}

Response samples

Content type
application/json
null

Customer Address Removal

Remove an address for a Customer for a certain nuDeliverItCompany

Authorizations:
BasicAuthentication
path Parameters
companyCode
required
string

Code of the nuDeliverIt Company to which the Customer belongs to

Request Body schema: application/json

APIRequest

accountNumber
required
string <= 20 characters

Unique alpha numeric value used to refer a Customer.

addressLabel
required
string <= 50 characters

Unique alpha numeric value used to refer a Address label.

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "ACC_123",
  • "label": "Primary"
}

Response samples

Content type
application/json
null

Demand API

Demand Import

Demand API is used to create a request to create/update a demand.

Authorizations:
BasicAuthentication
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

Company Code to which the Demand belongs to

Request Body schema: application/json

importRequest

companyCode
required
string

CompanyCode from application

demandPool
required
string <= 50 characters

DemandPool Name to which Demand belongs to.

required
Array of objects (Demands)

Responses

Request samples

Content type
application/json
{
  • "companyCode": "XYZ",
  • "demandPool": "demandPool_001",
  • "demands": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success"
}