NextBillion.ai

https://nextbillion.ai/developers/
Admin
NextBillion.ai is a route planning and optimization platform providing APIs for distance matrices,...
Tokens:31,195
Snippets:307
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Import Deck.gl with Aliases

Source: https://nextbillion.ai/developers/notebooks/animating-trip-data

This code imports the Deck.gl library, aliasing specific modules for use in the project. Ensure Deck.gl is installed or available in your environment.

```javascript
deck = require.alias({ h3: {}, s2Geometry: {} })("deck.gl@8.8.23/dist.min.js")
```

--------------------------------

### Global Route Object Example

Source: https://nextbillion.ai/developers/notebooks/maps-sdk-examples

This object represents the detailed information returned for a generated global route, including geometry, distance, and duration.

```javascript
const globalRoute = {
  geometry: "grm|_A`xlp`FjEiFyHcLgClCwHhInMjOrFjGbSnTdPfR|E`FbD…I?jE@zC?xWBjWBbX?dtAm@|lAgR_@{Gy@gGmBoUoOiHjMaErI",
  distance: 61668.9,
  duration: 2370.9,
  legs: [
    {
      distance: { value: 61668 },
      duration: { value: 2370 },
      steps: []
    }
  ]
};
```

--------------------------------

### GET /mvrp/optimization

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Retrieves the optimized routing solution for a given MVRP request, detailing vehicle paths, service times, and distances.

```APIDOC
## GET /mvrp/optimization

### Description
Retrieves the result of an MVRP optimization task, including route summaries and specific vehicle steps.

### Response
#### Success Response (200)
- **description** (string) - Description of the optimization task.
- **result** (object) - The optimization result object.
  - **code** (integer) - Status code of the operation.
  - **summary** (object) - Aggregated metrics including cost, routes, unassigned tasks, and total distance.
  - **routes** (array) - List of vehicle routes.
    - **vehicle** (integer) - Vehicle identifier.
    - **steps** (array) - Sequence of stops including start, pickup, delivery, and end types.

#### Response Example
{
  "description": "MVRP Tutorial 2023-11-06T09:44:19.848Z",
  "result": {
    "code": 0,
    "summary": {
      "cost": 4869,
      "routes": 1,
      "distance": 31088
    },
    "routes": [
      {
        "vehicle": 15,
        "steps": [
          { "type": "start", "location": [12.978527, 77.665694] },
          { "type": "delivery", "id": 3, "location": [12.9613508, 77.5369594] }
        ]
      }
    ]
  }
}
```

--------------------------------

### Retrieve Optimization Result

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Use this GET request to retrieve the results of a previously created optimization job. Replace '{your_api_key}' with your actual API key and ensure the 'id' parameter matches the job ID.

```curl
curl --location --request GET 'https://api.nextbillion.io/optimization/v2/result?id=838ed059acf380cc0c3e2fe05f0b25ff&key={your_api_key}'
```

--------------------------------

### Initialize NB.ai SDK

Source: https://nextbillion.ai/developers/notebooks/clustered-point-display

Initialize the NB.ai SDK with your API key. Obtain your API key from support@nextbillion.ai.

```javascript
nextbillion.setApiKey(your_api_key)
```

--------------------------------

### Set API Key

Source: https://nextbillion.ai/developers/notebooks/styled-clusters-of-points

Initialize the SDK by setting the API key obtained from support.

```javascript
nextbillion.setApiKey("your_api_key_here");
```

--------------------------------

### GET /optimization/v2/result

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Retrieves the solution for a specific route optimization job using the unique request ID generated during job submission.

```APIDOC
## GET /optimization/v2/result

### Description
Retrieves the optimization solution for a previously submitted job using the unique request ID.

### Method
GET

### Endpoint
https://api.nextbillion.io/optimization/v2/result

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique request ID returned when the optimization job was created.
- **key** (string) - Required - Your API authentication key.

### Request Example
curl --location --request GET 'https://api.nextbillion.io/optimization/v2/result?id=dca5b50dc5e5df4b5d8b81f4ad56d5ae&key={your_api_key}'

### Response
#### Success Response (200)
- **mvrpID** (object) - Contains the optimization job status and details.

#### Response Example
{
   "mvrpID": {
      "id": "dca5b50dc5e5df4b5d8b81f4ad56d5ae",
      "message": "Optimization job created",
      "status": "Ok",
      "warning": ["location_index[0] is used for both pickups/deliveries as well as vehicle start/end"]
   }
}
```

--------------------------------

### Initialize NextBillion.ai SDK

Source: https://nextbillion.ai/developers/notebooks/maps-sdk-examples

Set the API key to authenticate requests. This is a mandatory one-time initialization step.

```javascript
// Set API key
nextbillion.setApiKey(....);
```

--------------------------------

### GET /route/optimization

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Retrieves the optimized route details, including a sequence of stops, travel duration, distance, and the encoded polyline geometry.

```APIDOC
## GET /route/optimization

### Description
Retrieves the calculated route optimization data, including stop details, load information, and the encoded geometry path.

### Method
GET

### Endpoint
/route/optimization

### Response
#### Success Response (200)
- **stops** (array) - List of route stops including type, arrival time, duration, and location coordinates.
- **distance** (integer) - Total distance of the route in meters.
- **duration** (integer) - Total duration of the route in seconds.
- **geometry** (string) - Encoded polyline string representing the route path.

#### Response Example
{
  "stops": [
    {
      "type": "delivery",
      "arrival": 1688398437,
      "duration": 3837,
      "location": [13.0093793, 77.7079163],
      "distance": 24970
    }
  ],
  "distance": 39717,
  "duration": 6614,
  "geometry": "{|enAia`yM????????a@HWHILEF..."
}
```

--------------------------------

### Initialize Interactive Map

Source: https://nextbillion.ai/developers/notebooks/vehicle-breakdown-contingency-plan

Creates a map instance and draws depot and order markers based on provided city and job data.

```javascript
{
apiKey;

  const centroid = city.centroid.split(",");
  const nbmap = createMap("map", centroid);

  nbmap.on("load", function () {
    drawDepot(nbmap.map, centroid);

    data.jobs.forEach((job, i) => {
      drawOrder(nbmap.map, job.location);
    });
  });
}
```

--------------------------------

### Prototype Configuration Methods

Source: https://nextbillion.ai/developers/notebooks/animating-trip-data

Methods to configure the API environment and feature flags.

```APIDOC
## Configuration Methods

### Description
These methods allow for the dynamic configuration of the API client, including authentication and host routing.

### Methods
- **setApiKey(key)**: Sets the API key for authentication.
- **setApiHost(host)**: Sets the API host URL (default: api.nextbillion.io).
- **EnableNBTransform()**: Enables the NBTransform feature.
- **DisableNBTransform()**: Disables the NBTransform feature.

### Parameters
- **key** (string) - Required - The API key provided by NextBillion.ai.
- **host** (string) - Required - The base URL for the API service.
```

--------------------------------

### Sample Orders Data Structure

Source: https://nextbillion.ai/developers/notebooks/volume-ltl-shipping-implementation

An array of objects representing store orders, including details like store name, city, and appliance counts.

```javascript
ordersTable = Array(12) [
 0: Object {Store: "Smitham Inc", City: "Austin", ac: 0, fridge: 4, dish_washer: 4, washing_machine: 4}
 1: Object {Store: "Goyette, Stroman and Schiller", City: "Austin", ac: 3, fridge: 2, dish_washer: 2, washing_machine: 4}
 2: Object {Store: "Feest and Hermann", City: "Austin", ac: 5, fridge: 3, dish_washer: 5, washing_machine: 1}
 3: Object {Store: "Bashirian and Sons", City: "Austin", ac: 5, fridge: 4, dish_washer: 4, washing_machine: 3}
 4: Object {Store: "Jones - Durgan", City: "Los Angeles", ac: 3, fridge: 0, dish_washer: 4, washing_machine: 0}
 5: Object {Store: "Larson - Schowalter", City: "Los Angeles", ac: 0, fridge: 1, dish_washer: 0, washing_machine: 0}
 6: Object {Store: "Baumbach, Gutkowski and Schinner", City: "Los Angeles", ac: 4, fridge: 4, dish_washer: 4, washing_machine: 3}
 7: Object {Store: "Stark Inc", City: "Los Angeles", ac: 0, fridge: 3, dish_washer: 2, washing_machine: 2}
 8: Object {Store: "Casper, Bashirian and Bogisich", City: "Detroit", ac: 4, fridge: 5, dish_washer: 2, washing_machine: 3}
 9: Object {Store: "Keeling Inc", City: "Detroit", ac: 3, fridge: 3, dish_washer: 0, washing_machine: 0}
 10: Object {Store: "Mueller - Bosco", City: "Detroit", ac: 0, fridge: 4, dish_washer: 3, washing_machine: 2}
 11: Object {Store: "Rice - MacGyver", City: "Detroit", ac: 4, fridge: 3, dish_washer: 3, washing_machine: 4}
]
```

--------------------------------

### Retrieve MVRP Optimization Results via API

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Use a GET request to the Route Optimization API, providing the optimization job ID and your API key, to fetch the computed results of the MVRP problem.

```curl
curl --location --request GET 'https://api.nextbillion.io/optimization/v2/result?id=b74660af05894efc27624334391ec506&key={your_api_key}'
```

--------------------------------

### Import NB.ai Web SDK Dependencies

Source: https://nextbillion.ai/developers/notebooks/clustered-point-display

Import necessary dependencies for the NB.ai Web SDK. Ensure these are included in your project's build process.

```javascript
import { nextbillion, parameters, cities, secret2 } from "@nbai/nextbillion-ai-dependencies"
```

--------------------------------

### Initialize API Key

Source: https://nextbillion.ai/developers/notebooks/simple-distance-matrix-example

Set the API key required for authenticating requests to the NextBillion.ai services.

```javascript
nextbillion.setApiKey(your_api_key);
```

--------------------------------

### Integrate NextBillion.ai SDK Stylesheet

Source: https://nextbillion.ai/developers/notebooks/simple-distance-matrix-example

Include this link tag in your project to load the necessary styles for the NextBillion.ai maps SDK.

```html
link href="https://maps-gl.nextbillion.io/maps/v2/api/css" rel="stylesheet" 
```

--------------------------------

### MVRP Tutorial API Response

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

This snippet details the structure of the response received from the MVRP Tutorial API. It includes a summary of the routing results and a breakdown of each route.

```APIDOC
## API Response Structure

### Description
This section describes the structure of the API response for the MVRP Tutorial, which includes overall summary statistics and detailed information about each generated route.

### Response Body

- **description** (string) - A timestamp or identifier for the generated route plan.
- **result** (object) - Contains the main routing results.
  - **code** (integer) - Status code of the operation (e.g., 0 for success).
  - **summary** (object) - Aggregated statistics for the entire routing solution.
    - **cost** (integer) - Total cost of the routes.
    - **routes** (integer) - Number of routes generated.
    - **unassigned** (integer) - Number of unassigned tasks.
    - **setup** (integer) - Total setup time.
    - **service** (integer) - Total service time.
    - **duration** (integer) - Total duration of all routes.
    - **waiting_time** (integer) - Total waiting time.
    - **priority** (integer) - Total priority value.
    - **delivery** (array of integers) - List of delivery location indices.
    - **pickup** (array of integers) - List of pickup location indices.
    - **distance** (integer) - Total distance covered by all routes.
  - **routes** (array of objects) - An array containing details for each individual route.
    - **vehicle** (integer) - Identifier for the vehicle assigned to this route.
    - **cost** (integer) - Cost of this specific route.
    - **steps** (array of objects) - A list of steps (actions) within this route.
      - **type** (string) - Type of step (e.g., 'start', 'pickup', 'delivery').
      - **arrival** (integer) - Timestamp of arrival at the step location.
      - **duration** (integer) - Duration of the service or travel at this step.
      - **service** (integer) - Service time at this step.
      - **waiting_time** (integer) - Waiting time at this step.
      - **location** (array of floats) - Latitude and longitude coordinates of the location.
      - **location_index** (integer) - Index of the location in the original input.
      - **id** (integer, optional) - Identifier for the task (pickup or delivery).
      - **load** (array of integers, optional) - Load changes at this step.
      - **description** (string, optional) - Description of the task.
      - **distance** (integer) - Distance traveled to reach this step from the previous one.

### Response Example
```json
{
    "description": "MVRP Tutorial 2023-11-02T07:21:16.295Z",
    "result": {
        "code": 0,
        "summary": {
            "cost": 37531,
            "routes": 5,
            "unassigned": 0,
            "setup": 0,
            "service": 0,
            "duration": 37531,
            "waiting_time": 0,
            "priority": 0,
            "delivery": [
                18
            ],
            "pickup": [
                18
            ],
            "distance": 237030
        },
        "routes": [
            {
                "vehicle": 2,
                "cost": 6614,
                "steps": [
                    {
                        "type": "start",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 0,
                        "load": [
                            0
                        ],
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 0,
                        "id": 8,
                        "load": [
                            1
                        ],
                        "description": "184, F",
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 0,
                        "id": 6,
                        "load": [
                            2
                        ],
                        "description": "183, M",
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 0,
                        "id": 30,
                        "load": [
                            3
                        ],
                        "description": "195, M",
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 0,
                        "id": 14,
                        "load": [
                            4
                        ],
                        "description": "187, M",
                        "distance": 0
                    },
                    {
                        "type": "delivery",
                        "arrival": 1688396308,
                        "duration": 1708,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            13.0328962,
                            77.6271395
                        ],
                        "location_index": 7,
                        "id": 13,
                        "load": [
                            3
                        ],
                        "description": "187, M",
                        "distance": 11042
                    },
                    {
                        "type": "delivery",
                        "arrival": 1688397138,
                        "duration": 2538,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            13.0229614,
                            77.65969729999999
                        ],
                        "location_index": 15,
                        "id": 29,
                        "load": [
                            0
                        ],
                        "description": "187, M",
                        "distance": 11042
                    }
                ]
            }
        ]
    }
}
```
```

--------------------------------

### Interactive Directions Map Initialization

Source: https://nextbillion.ai/developers/notebooks/maps-sdk-examples

Initializes an interactive map for directions using NextBillion.ai. It sets up markers for origin, destination, and waypoints, and handles map click events to define these points. Requires a container element with id 'mapDir' and a 'clearMap' button.

```javascript
directionsMap = {
  apiKey;
  yield container;
  let routePolyline = null;
  let originMarker = null;
  let destinationMarker = null;
  let waypoints = [];
  let pos = {
    lat: panel.city.centroid.split(",")[0],
    lng: panel.city.centroid.split(",")[1]
  };
  const mapDir = (container.value = new nextbillion.maps.Map({
    container: document.getElementById("mapDir"),
    center: pos,
    zoom: 8,
    maxZoom: 15,
    minZoom: 5,
    style: panel.styles.value,
    scrollZoom: true
  }));

  loadMapActions(mapDir);

  document.getElementById("clearMap").onclick = function () {
    clearMap(mapDir, originMarker, destinationMarker, waypoints);
    originMarker = null;
    destinationMarker = null;
    waypoints = [];
  };
  // click on map actions - create origin or destination
  mapDir.map.on("click", (e) => {
    if (!originMarker) {
      originMarker = new nextbillion.maps.Marker({
        color: "green",
        draggable: true,
       scale: 0.6
      })
        .setLngLat({
          lat: e.lngLat.lat,
          lng: e.lngLat.lng
        })
        .addTo(mapDir.map);
      originMarker.on("dragend", (e) => {
        routeMe(mapDir, originMarker, destinationMarker, waypoints, false);
      });
    } else if (!destinationMarker) {
      destinationMarker = new nextbillion.maps.Marker({
        color: "red",
        draggable: true,
        scale: 0.6
      })
        .setLngLat({
          lat: e.lngLat.lat,
          lng: e.lngLat.lng
        })
        .addTo(mapDir.map);
      destinationMarker.on("dragend", (e) => {
        routeMe(mapDir, originMarker, destinationMarker, waypoints, false);
      });
    } else {
      // waypoint
      var waypointMarker = new nextbillion.maps.Marker({
        color: "blue",
        draggable: true,
        scale: 0.6
      })
        .setLngLat({
          lat: e.lngLat.lat,
          lng: e.lngLat.lng
        })
        .addTo(mapDir.map);
      waypointMarker.on("dragend", (e) => {
        routeMe(mapDir, originMarker, destinationMarker, waypoints, false);
      });
      waypoints.push(waypointMarker);
    }
    if (originMarker && destinationMarker) {
      routeMe(mapDir, originMarker, destinationMarker, waypoints, false);
    }
  });
}
```

--------------------------------

### Set NB.ai API Key

Source: https://nextbillion.ai/developers/notebooks/shared-mobility-bike-data

Initialize your NextBillion.ai API key before implementing visualizations. Contact support@nextbillion.ai to obtain an API key.

```javascript
nextbillion.setApiKey('your-api-key-here');
```

--------------------------------

### Load Employee Data CSV

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

This snippet demonstrates how to load employee data from a CSV file. Ensure the CSV contains pickup locations and shift time constraints.

```python
import pandas as pd

employee_data = pd.read_csv('employee_data.csv')
print(employee_data.head())
```

--------------------------------

### Render Map and Draw Routes

Source: https://nextbillion.ai/developers/notebooks/volume-ltl-shipping-implementation

Renders a map using NextBillion.ai's Web Maps SDK and draws routes for the origin hub and manufacturers. This code runs after the map is loaded.

```javascript
const nbmap = new nextbillion.maps.Map({
    container: document.getElementById("map-2"),
    center: {
      lat: CITIES.columbus.centroid[1],
      lng: CITIES.columbus.centroid[0]
    },
    zoom: 10,
    maxZoom: 15,
    minZoom: 0,
    style: "https://api.nextbillion.io/maps/streets/style.json",
    scrollZoom: true
  });

  nbmap.on("load", () => {
    drawHub(nbmap.map, ORIGIN_HUB);
    MANUFACTURERS.forEach((manufacturer) =>
      drawManufacturer(nbmap.map, manufacturer)
    );
    companiesToOriginHubDirections.forEach((directions, i) => {
      drawRoute(nbmap.map, `route-${i}`, directions[0], COLORS[i]);
    });
  });
```

--------------------------------

### Integrate NB.ai SDK Stylesheet

Source: https://nextbillion.ai/developers/notebooks/clustered-point-display

Add the NB.ai SDK stylesheet to your project for seamless integration. This ensures all map components and styles are correctly rendered.

```html
link href="https://maps-gl.nextbillion.io/maps/v2/api/css" rel="stylesheet"
```

--------------------------------

### Retrieve Optimization Result using cURL

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Use this cURL command to retrieve the optimization solution by providing the job ID and your API key. Replace '{your_api_key}' with your actual API key.

```bash
curl --location --request GET 'https://api.nextbillion.io/optimization/v2/result?id=dca5b50dc5e5df4b5d8b81f4ad56d5ae&key={your_api_key}'
```

--------------------------------

### Load Vehicle Data CSV

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

This snippet shows how to load vehicle data from a CSV file. The data should include vehicle initial locations and maximum capacity.

```python
import pandas as pd

vehicle_data = pd.read_csv('vehicle_data.csv')
print(vehicle_data.head())
```

--------------------------------

### Add SDK Stylesheet

Source: https://nextbillion.ai/developers/notebooks/maps-sdk-examples

Include the required CSS stylesheet to ensure proper rendering of map components.

```html
// Add the stylesheet for the NB.ai SDK 
link href="https://maps-gl.nextbillion.io/maps/v2/api/css" rel="stylesheet"
```

--------------------------------

### Calculate Directions to Origin Hub

Source: https://nextbillion.ai/developers/notebooks/volume-ltl-shipping-implementation

Uses NextBillion.ai's Directions API to generate routes from manufacturers to an origin hub. This snippet demonstrates asynchronous calculation using Promise.all.

```javascript
companiesToOriginHubDirections = Promise.all(
  MANUFACTURERS.map((manufacturer) =>
    getDirection(manufacturer.location, ORIGIN_HUB.location)
  )
);
```

--------------------------------

### Configure MVRP Input Data

Source: https://nextbillion.ai/developers/notebooks/volume-ltl-shipping-implementation

The structure for defining depots, locations, jobs, and vehicles required for the MVRP solver.

```javascript
mvrpInputs = Object {
  depots: Array(1) [
    0: Object {id: 0, location_index: 0}
  ]
  locations: Object {
    id: 1
    location: "39.9869,-82.99876|30.32101,-97.73751|34.04014,-118.24741|42.38504,-83.07939"
  }
  jobs: Array(115) [
    // Details of 115 jobs representing delivery tasks, including location indices and pickup weights
  ]
  vehicles: Array(10) [
    // Details of 10 vehicles (trucks) with unique identifiers, capacity configurations, and maximum task limits
  ]
}
```

--------------------------------

### API Response JSON

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

This is a sample API response showing the structure of route optimization results. It includes a summary of costs, routes, and detailed steps for each vehicle.

```json
{
    "description": "MVRP Tutorial 2023-11-06T10:13:35.568Z",
    "result": {
        "code": 0,
        "summary": {
            "cost": 3410,
            "routes": 1,
            "unassigned": 0,
            "setup": 0,
            "service": 0,
            "duration": 3410,
            "waiting_time": 0,
            "priority": 0,
            "delivery": [
                3
            ],
            "pickup": [
                3
            ],
            "distance": 25573
        },
        "routes": [
            {
                "vehicle": 4,
                "cost": 3410,
                "steps": [
                    {
                        "type": "start",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 6,
                        "load": [
                            0
                        ],
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 3,
                        "id": 4,
                        "load": [
                            1
                        ],
                        "description": "190, F",
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 1,
                        "id": 2,
                        "load": [
                            2
                        ],
                        "description": "999, E",
                        "distance": 0
                    },
                    {
                        "type": "pickup",
                        "arrival": 1688394600,
                        "duration": 0,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.978527,
                            77.665694
                        ],
                        "location_index": 5,
                        "id": 6,
                        "load": [
                            3
                        ],
                        "description": "182, F",
                        "distance": 0
                    },
                    {
                        "type": "delivery",
                        "arrival": 1688397615,
                        "duration": 3015,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.8479159,
                            77.6528024
                        ],
                        "location_index": 2,
                        "id": 3,
                        "load": [
                            2
                        ],
                        "description": "190, F",
                        "distance": 23709
                    },
                    {
                        "type": "delivery",
                        "arrival": 1688398010,
                        "duration": 3410,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.8424657,
                            77.6462378
                        ],
                        "location_index": 0,
                        "id": 1,
                        "load": [
                            1
                        ],
                        "description": "999, E",
                        "distance": 25573
                    },
                    {
                        "type": "delivery",
                        "arrival": 1688398010,
                        "duration": 3410,
                        "service": 0,
                        "waiting_time": 0,
                        "location": [
                            12.8424657,
                            77.6462378
                        ],
                        "location_index": 4,
                        "id": 5,
                        "load": [

```

--------------------------------

### Define Map Style Configuration

Source: https://nextbillion.ai/developers/notebooks/maps-sdk-examples

Configure the map appearance by mapping a style name to its corresponding JSON configuration URL.

```javascript
// Example Object
const mapStyle = {
  name: "Day",
  value: "https://api.nextbillion.io/maps/streets/style.json"
};
```

--------------------------------

### Set NextBillion API Key

Source: https://nextbillion.ai/developers/notebooks/vehicle-breakdown-contingency-plan

Set the API key for integrating NextBillion functionalities into your application. Ensure this is done before making any API calls.

```javascript
nextbillion.setApiKey(apiKey)
```

--------------------------------

### Optimization Solution Structure

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

This JSON structure represents a single route within an optimization solution, detailing stops, arrival times, durations, and locations.

```json
{
    "type": "end",
    "arrival": 1688398010,
    "duration": 3410,
    "service": 0,
    "waiting_time": 0,
    "location": [
        12.8424657,
        77.6462378
    ],
    "location_index": 7,
    "load": [
        0
    ],
    "distance": 25573
}
```

--------------------------------

### Execute MVRP for Long-Haul

Source: https://nextbillion.ai/developers/notebooks/volume-ltl-shipping-implementation

Asynchronous function to process MVRP inputs and return the optimization results.

```javascript
mvrpLongHaul = {
  const result = await MVRP(mvrpInputs);
  return result;
}
```

--------------------------------

### Route Summary Data Structure

Source: https://nextbillion.ai/developers/notebooks/employee-transportation-and-escort-services

Provides a summary of the entire route, including total service time, duration, waiting time, priority, and delivery/pickup counts. It also includes the total distance covered by the route.

```json
{
                "service": 0,
                "duration": 6614,
                "waiting_time": 0,
                "priority": 0,
                "delivery": [
                    4
                ],
                "pickup": [
                    4
                ],
                "distance": 39717
            }
```
Tokens:
Raw