Products
/
Better Route
/
Better Route Deep Integration
/
Tour Commander API
/
Custom Waypoint
/
Create a custom waypoint

Tour Commander API (1.0.0)

Part of Bettermile Route API responsible for tour management

Download OpenAPI description
tour-commander-api.json
tour-commander-api.yaml
Overview
E-mail

route-api@bettermile.com

License

Proprietary

Languages
Servers
Dev API

https://dev.routes.bettermile.com/

Tour

Operations on the tour level

Operations

Sequence

Operations on the sequence level

Operations

Waypoint

Operations on the waypoint level

Operations

Job

Operations on the job level

Operations

Custom Job

Operations on custom jobs

Operations

Custom Waypoint

Operations on custom waypoints

Operations

Create a custom waypoint

Request

Creates a custom waypoint by grouping provided jobs together

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

Bodyapplication/json
jobIdsJobInternalIds (object) or JobExternalIds (object)

IDs of the jobs to be added under the custom waypoint

One of:

IDs of the jobs to be added under the custom waypoint

addressAddress (object) or NullValue (null)

Specifies address to be used for the custom waypoint. If not provided one of the job addresses is used.

Any of:

Specifies address to be used for the custom waypoint. If not provided one of the job addresses is used.

curl -i -X POST \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/custom-waypoints' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Successfully created a custom waypoint

Bodyapplication/json
waypointIdstring(uuid)

Internal ID of the created custom waypoint

Response
application/json
{
  "waypointId": "6eeaf5f6-415c-49ff-97fc-2d3cc3a134f5"
}

Deletes a custom waypoint

Request

Deletes a custom waypoint, allowing the backend to regroup the jobs from this waypoint freely.

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

waypointIdstring(uuid)required

Unique waypoint identifier (generated by Better Route backend)

curl -i -X DELETE \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/custom-waypoints/{waypointId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully deleted the custom waypoint

Bodyapplication/json
dataobject
Example: {}
Response
application/json
{
  "data": {}
}