Overview

This guide outlines the steps to manage routing within the OneRail OmniPoint API integration, focusing on both manual routing and automated route optimization. It also explains handling internal and external fleets, and using delivery windows when applicable.

First, it must be determined whether orders/deliveries will be created manually via the platform's web interface or via API integration. This guide will discuss how to create orders/deliveries via API, for further information on manually creating orders and deliveries, refer to the following article: Creating a Delivery Order - Manual Creation.

Delivery or Order Creation Process

Before initiating routing, it's crucial to understand the difference between making a delivery and making an order within the OneRail system. These distinctions influence how routing and optimization are configured.

Making an Order

/order/create

An order represents a transaction or request initiated by a customer. It typically includes a list of items purchased, customer details, and any additional instructions related to the transaction. Orders are broader and often precede deliveries. They organize and track transactional details, which may eventually lead to one or more deliveries.

Orders are generally synchronized into the OneRail system from external e-commerce or ERP systems using APIs or integration tools.

For further information on this endpoint, refer to the following link: Swagger - Create an Order

Making a Delivery

/delivery/create

A delivery focuses on transporting goods from a pickup location to a drop-off location. It includes detailed logistics information, such as item dimensions, weights, delivery windows, and customer information.

Deliveries are downstream and they include operational specifications like SLA commitments, carrier details, and routing requirements.

For further information on this endpoint, refer to the following link: Swagger - Create a Delivery

Routing Through the API

Routing involves defining the specific sequence of stops and orders for deliveries using the /v1/routes endpoint.

Steps for Routing Using the API:

1. Identify Orders for Routing:

   • Select the orders that need to be included in the route.
   • Prepare the necessary order details, such as pickup and drop-off locations, delivery windows, and service levels.

2. Create the Route (POST /v1/routes):

   • Use the skipOptimizer attribute to control whether the sequence of stops should be optimized by the system or maintained as provided.
   • Define the sequence of deliveries explicitly in the orders array.
   • Swagger - Create a Route

3. Update Routes as Needed (PUT /v1/routes):

   • Modify existing routes by adding, removing, or resequencing orders using the same skipOptimizer configuration.

Route Optimizer Functionality

The OneRail API provides powerful route optimization capabilities to streamline delivery operations. The optimizer reorders stops within a route based on factors such as distance, delivery windows, and logistical constraints.

Controlling the Optimizer with skipOptimizer

• Attribute: skipOptimizer
  • Type: Boolean
  • Purpose: Determines whether the route optimizer is enabled for a route.
    • true: The route optimizer is bypassed, and the sequence of deliveries is respected as provided in the orders array.
    • false: The optimizer automatically reorders deliveries to minimize travel distance and time.

Benefits of the Route Optimizer

• Reduces overall travel time and fuel costs.
• Ensures adherence to delivery windows and other constraints.
• Automatically adjusts routes for efficiency without manual intervention.

Use Cases for skipOptimizer

1. Precise Routing:
   Set skipOptimizer: true when you need full control over the delivery sequence for scenarios like time-sensitive or priority-based deliveries.

2. Efficiency Optimization:
   Set skipOptimizer: false to let the system reorder stops for maximum efficiency, especially for high-volume operations or complex routes.

Example Using skipOptimizer

• Request with Optimization Disabled (skipOptimizer: true):

  {
  "routes": [
    {
      "id": "ROUTE456",
      "skipOptimizer": true,
      "orders": [ /* Custom sequence */ ]
    }
  ]
}  

• Request with Optimization Enabled (skipOptimizer: false):

  {
  "routes": [
    {
      "id": "ROUTE456",
      "skipOptimizer": false,
      "orders": [ /* System-reordered sequence */ ]
    }
  ]
}  

Internal vs. External Fleet

The type of fleet used significantly impacts the setup, routing, and optimization processes. It is important to understand the requirements and routing differences for managing internal and external fleets.

Internal Fleet

If your organization manages its own fleet of delivery vehicles, additional setup is required to ensure efficient routing and operational integration.

Setup Requirements

1. Market Configuration:

   • Define the geographic area or zones where your fleet operates.
   • Specify operational constraints like delivery cut-off times and service hours.
   • Markets are configured to align with your organization’s specific delivery regions.

2. Fleet Assets:

   • Register all vehicles in your fleet, including details such as capacity, weight limits, and vehicle types.
   • Ensure each vehicle is linked to its respective market to maintain accurate routing.

3. Service Level Agreements (SLAs):

   • Define pickup and drop-off commitments, including buffer times for delays and end-of-day deadlines.
   • SLAs help enforce expected service quality and time-based performance metrics.

Routing for Internal Fleets

• Routing and optimization take into account the specific capabilities and constraints of your fleet.
• Routes are tailored based on:
  • Vehicle capacity and load.
  • SLA requirements for pickup and delivery times.
  • Geographic constraints within defined markets.

External Fleet

If you use third-party delivery providers (carriers), the setup and routing processes are simplified since OneRail handles carrier integration.

Integration Process

1. Carrier Setup:

   • Ensure that your chosen carriers are integrated into the OneRail platform.
   • Confirm that contracts and service levels with carriers are properly configured.

2. Routing with External Fleets:

   • Routing decisions are handled by OneRail using carrier data, which includes fleet availability, geographic coverage, and SLA constraints.
   • The system selects the most suitable carrier based on delivery requirements and cost-effectiveness.

Advantages of Using External Fleets

• No need to manage vehicle registration, maintenance, or market configurations.
• Simplified operations with minimal setup.
• Greater flexibility by leveraging multiple carriers for broader geographic coverage.