Skip to main content

Introduction to SWAT API

SWAT offers three API products:

  • Stateless API: Provides access to our VRP solver technology. It offers maximum flexibility but requires more complex integration. SWAT systems do not store or retain customer data when using this API.
  • Integration API: Manages data within the SWAT system, such as customer orders, fleet information, and customer master data. It is the primary method for interacting with SWAT products and integrating with systems like TMS, OMS, WMS, or others. This stateful API allows you to execute custom optimization pipelines without the complexities of the Stateless API.
  • Routing API: Generates routes, following an extended OSRM standard protocol and supporting dynamic predictive traffic.

All APIs can be used independently.

SWAT APIs offer advanced capabilities for route generation, route optimization, and load optimization, leveraging state-of-the-art technologies. APIs are grouped into three categories:

  • Route and time/distance matrix generation (referred to as Routing API)
  • Route optimization where the integrator manages waypoints, vehicles, loads, and all static data (referred to as Optimization API)
  • Route optimization where all data is managed by SWAT systems (referred to as Integration API)

This latter group of APIs also enables integrators to exchange data with SWAT applications like Logistics Route Generate and People Transportation. This facilitates the automation of workflows between ERPs, TMS, WMS, OMS, Google Spreadsheets, and other systems, as well as SWAT application suites.

SWAT APIs support multiple processing pipelines, allowing for a wide range of operations, including:

  • On-demand operations: Orders are assigned to the fleet in real-time.
  • Pre-order operations: Orders are grouped before optimization.
  • Advanced constraints: Optimizes for factors such as driver breaks, slack management, variable vehicle costs, temporary road restrictions, vehicle utilization efficiency, prohibiting certain orders in the same vehicle, geofencing, driver working shifts, and more.
  • Manual editing of assigned routes
  • Manual and automatic order splitting and grouping
  • Island deliveries, multiple distribution center support
  • Complete pickup-delivery support: Supports multi-point pickups and drop-offs, as well as "star" delivery models.
  • ... and many more

SWAT Route Generation uses hyper-localized maps, carefully curated and maintained by the SWAT GIS team, which reflect the specific characteristics of operational regions. If you encounter an unexpected route generation outcome, please contact our friendly team at [service@swatmobility.com].

tip

To align with industry terminology, some terms are used interchangeably throughout the documentation. For example, from an API perspective, booking and order refer to the same entity. However, order is primarily used for logistics applications, while booking is used for passenger applications.

Delivery process​

To understand our delivery process, please review the datamodel first.

The process typically encompasses the following steps:

  1. SWAT Provisions Basic Configuration: SWAT prepares the essential foundational configuration for the integrator, including establishing the project, initiating the simulation template, and generating primary user credentials. Each end customer is allocated at least one project, acting as a container for isolating user, passenger, and driver accounts, principally for user management purposes. It is discouraged to utilize projects for segregating operational aspects, such as distinct data centers or fleets. Instead, simulation templates and instances serve this function.

  2. Initial Configuration for Simulation Templates: SWAT establishes the initial configuration for project "simulation templates." These templates encapsulate the standardized configurations necessary for executing operations. The templates are highly adaptable, with numerous parameters enabling the optimization of specific operations for each client. Following template creation, the integrator can automatically replicate the settings for each day of operations and execute configuration modifications as required.

  3. Postman Collections and OpenAPI Specifications: SWAT provides access to Open API specifications for all APIs

Typical configuration flow​

Configuring a project and workflow to optimize routing for customers can be challenging but isn't impossible. The SWAT customer support team usually handles this task, ensuring optimal route efficiency that aligns with the operational needs of each customer.

Getting Started​

Get started by exploring our Postman Collections

Run In Postman

Terminology​

Please review terminology section of this guide. Terminology

Use cases​

SWAT route optimization capability is very flexible and supports various cost functions (optimization criteria) and 200+ various constrains enabling the integrator to configure the engine in a way that is matching their business operations. We have prepared some examples of upcases linked to Postman collections and a playground that may help understand how constrains and cost functions are playing with each other.

Classes of optimization problems​

SWAT optimization engine can address the following classes of optimization problems:

  • Route Optimization with one vehicle (Traveling Salesman Problem)
  • Route Optimization with multiple vehicles
  • Route Optimization with capacitated vehicles
  • Route and vehicle allocation Optimization with pickups and deliveries
  • Route and vehicle allocation Optimization with pickups and deliveries with time windows

SWAT Optimization capabilities support flexible optimization criteria and constrains that can minimize vehicle use, complete more orders with shorter milage deliver outstanding customer experience at the same time while producing operationally feasible routes and meeting safety and labour local regulations.

Operational modes

SWAT API provides a number of operational modes to support a large variety of scenarios including:

  • Static route optimization with or without booking (DFR)
  • Just In Time route optimization (JIT)
  • On Demand (On Demand) support for live operations
  • Combination of On Demand and preplanned routes
  • Wave planning and multi DC planning

Our engagement with integrators and API consumers​

SWAT is focused on getting our integrators go in no time. To achieve that, we will allocated a deducted service delivery lead from our team to help identify how SWAT service would fit best with your operations and IT systems. We will establish a dedicated workspace where your team will be able to collaborate on data, capabilities and process with our team members in real time.

Data model​

SWAT is using a comprehensive data model representing field operations. Please review relations of objects within the data model.

API Reference​

API Reference provides a complete documentation for all endpoints