iotoms Docs

Update a route plan

PUT
/api/v1/ops/route-plans/{templateId}

Updates a route plan's name, code and coverage target. The store list you send replaces the existing one entirely, so always send the full ordered list.

How to use it

  1. Read the current plan with Get a route plan.
  2. Send planName, planCode, coverageTarget and the complete stores list in visit order; stores left out are removed from the plan.
  3. The assigned vehicle is kept. New visit lists use the updated stores when a salesperson next starts a day on this plan.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

templateId*string

ID of the route plan, from List route plans.

Formatuuid

Header Parameters

Request Body

application/json
  1. body
planName*string

Required. Display name of the route plan.

planCode*string

Required. Short code of the route plan.

coverageTarget*integer

Required. Coverage goal for the route plan, as a whole number greater than zero.

Formatint32
stores*array<>

Required, at least one. The full ordered store list; on update it replaces the existing list.

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?

The route plan with its ordered stores and any assigned vehicle.

Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/ops/route-plans/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "planName": "string",  "planCode": "string",  "coverageTarget": 0,  "stores": [    {      "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",      "storeName": "string",      "sequence": 0    }  ]}'
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"  }}