Route Management

Create Route

Creating a route is a straightforward process using Create Route API. However, please note that routes can only be created for orders classified as Pickup-Only or Dropoff-Only. If any of the provided order IDs correspond to a point-to-point delivery, the route will not be created. Additionally, you may include the assigneeId for the route, which represents the driver ID assigned to the route.

Provided two Pickup-Only order IDs and a driver ID, the following payload can be used to create a route.

{
  "orderIds": [
    "1c786e267297",
    "dff6d60d1c58"
  ],
  "assigneeId": "507f191e810c19729de860ea"
}

Filter Route

To retrieve the scheduled routes within a specified date range, the Filter Route API can be utilized. This is a GET endpoint that requires query information to be provided through URL query parameters. The following parameters are supported:
filter: Specifies the type of query. Currently, the only supported filter type is scheduled-date.
from: Represents the starting timestamp for the query. The value must be provided as an ISO date string.
to: Denotes the ending timestamp for the query. This parameter must also be provided as an ISO date string.

Notes:
1. The date range specified using the from and to parameters must not exceed a maximum of three (3) days.
2. If only the from parameter is provided, the to parameter will be automatically calculated by adding three (3) days to the specified starting date.

curl --location 'https://api.fulflld.com/v1/route?filter=scheduled-date&from=2025-01-14T14%3A38%3A36.575Z&to=2025-01-14T14%3A38%3A36.575Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <access-token>'

Get Route

To retrieve a specific route using Get Route, it is essential to provide the Route ID. This ID can be obtained either during the creation of the route or by filtering the routes, as outlined in the preceding section.

Provided a Route ID, the following request can retrieve a route,

curl --location 'https://api.fulflld.com/v1/route/6786722594ec33e10afb0684' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <access-token>'

Update Route

You can provide a partial payload containing only the fields you wish to update using Update Route. For instance, if you need to update the ordersSequence, you can include only the ordersSequence portion in the request payload.

Suppose we have the following order sequence.

"ordersSequence": [
   {
       "id": "1c786e267297",
       "type": "order",
       "index": 0
   },
   {
       "id": "dff6d60d1c58",
       "type": "order",
       "index": 1
   }
]

If I decide to change the sequence, I can rearrange it as shown.

"ordersSequence": [
   {
       "id": "dff6d60d1c58",
       "type": "order",
       "index": 1
   },
   {
       "id": "1c786e267297",
       "type": "order",
       "index": 0
   }
]