List Routes

GET

/route

Retrieve available routes with pagination support, ordered by SAP code ascending. Returns comprehensive route information including warehouse details, coordinates, distances, and timing data.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

Routes have been successfully retrieved with pagination

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://fmsapi.deltax.la/clients/route?page=1&size=20' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Routes retrieved successfully",
    "data": {
        "routes": [
            {
                "_id": "507f1f77bcf86cd799439016",
                "sapCode": "500059",
                "originName": "WAREHOUSE ORIGIN A",
                "originI2Code": "2070603000",
                "originSapCode": "W001",
                "originLng": -99.1332,
                "originLat": 19.4326,
                "destinationName": "WAREHOUSE DESTINATION A",
                "destinationI2Code": "2070603001",
                "destinationSapCode": "W002",
                "destinationLng": -99.2,
                "destinationLat": 19.5,
                "distanceKm": 25.5,
                "originTimeHr": 1.5,
                "transitTimeHr": 3,
                "destinationTimeHr": 2,
                "returnTransitTimeHr": 3.5,
                "fullTripTimeHr": 10
            },
            {
                "_id": "507f1f77bcf86cd799439017",
                "sapCode": "500060",
                "originName": "WAREHOUSE ORIGIN B",
                "originI2Code": "2070603002",
                "originSapCode": "W003",
                "originLng": -99.3,
                "originLat": 19.6,
                "destinationName": "WAREHOUSE DESTINATION B",
                "destinationI2Code": "2070603003",
                "destinationSapCode": "W004",
                "destinationLng": -99.4,
                "destinationLat": 19.7,
                "distanceKm": 40.2,
                "originTimeHr": 2,
                "transitTimeHr": 4.5,
                "destinationTimeHr": 2.5,
                "returnTransitTimeHr": 4,
                "fullTripTimeHr": 13
            }
        ],
        "pagination": {
            "page": 1,
            "size": 20,
            "totalRoutes": 75,
            "totalPages": 4,
            "hasNextPage": true,
            "hasPreviousPage": false
        }
    }
}

Modified at 2025-11-21 22:26:35

List Trips

Get Route by ID