iotoms Docs

List route plans

GET
/api/v1/ops/route-plans

Returns every route plan for the merchant, each with its stores in visit order, coverage target and assigned vehicle. Not paginated.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?array<>|

Every route plan for the merchant.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/route-plans'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "planName": "string",      "planCode": "string",      "coverageTarget": 0,      "assignedVehicle": {        "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",        "vehicleNumber": "string",        "vehicleLabel": "string",        "vehicleType": "VAN"      },      "stores": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",          "customerStoreId": 0,          "storeCode": "string",          "storeName": "string",          "sequence": 0,          "geoLat": 0,          "geoLon": 0        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}