---
title: "add a waypoint to a route"
method: POST
path: "/routes/{id}/waypoints"
tags: ["Routes"]
---

# add a waypoint to a route

`POST /routes/{id}/waypoints`

add a waypoint to a route (the waypoints will be added at the end of the route)

## Path parameters

- `id` string, required

## Request body

- object[] — Waypoints to add
  - `scheduledDate` string, date-time — Waypoint scheduled date
  - `poiId` number — Poi id processed on waypoint
  - `visited` boolean — Waypoint visited
  - `longitude` number — Waypoint visited exact location longitude
  - `latitude` number — Waypoint visited exact location latitude
  - `vehicleId` number — Waypoint vehicle assigned
  - `visitedAt` string, date-time — Waypoint visit date
  - `visitDuration` integer — Waypoint visit duration
  - `totalValue` number — Waypoint total amount
  - `pallets` number — Waypoint pallets
  - `createdAt` string, date-time — Waypoint created date
  - `departedAt` string, date-time — Waypoint departure date
  - `comments` string — Waypoint comments
  - `scheduledArrivalTimestamp` string, date-time — Waypoint scheduled visit arrival
  - `scheduledDepartureTimestamp` string, date-time — Waypoint scheduled visit departure
  - `visitOrder` integer — Waypoint visit order
  - `activities` object
    - `type` 'pickup' | 'task' | 'delivery' — Activity type
    - `orders` object[]
      - `_id` union — Order ID
        - integer
        - string
      - `weight` union — Weight
        - integer
        - string
      - `deliveredWeight` union — Delivered weight
        - integer
        - string
    - `tasks` object[]
      - `_id` union — Task ID
        - integer
        - string

## Response `200`

add waypoints to a route

- object
  - `meta` object
    - `limit` integer — Number of rows retrieved
    - `offset` integer — Number of rows skipped
    - `total` integer — Total number of rows
  - `data` object[]
    - `scheduledDate` string, date-time — Waypoint scheduled date
    - `poiId` number — Poi id processed on waypoint
    - `visited` boolean — Waypoint visited
    - `longitude` number — Waypoint visited exact location longitude
    - `latitude` number — Waypoint visited exact location latitude
    - `vehicleId` number — Waypoint vehicle assigned
    - `visitedAt` string, date-time — Waypoint visit date
    - `visitDuration` integer — Waypoint visit duration
    - `totalValue` number — Waypoint total amount
    - `pallets` number — Waypoint pallets
    - `createdAt` string, date-time — Waypoint created date
    - `departedAt` string, date-time — Waypoint departure date
    - `comments` string — Waypoint comments
    - `scheduledArrivalTimestamp` string, date-time — Waypoint scheduled visit arrival
    - `scheduledDepartureTimestamp` string, date-time — Waypoint scheduled visit departure
    - `visitOrder` integer — Waypoint visit order
    - `activities` object
      - `type` 'pickup' | 'task' | 'delivery' — Activity type
      - `orders` object[]
        - `_id` union — Order ID
          - integer
          - string
        - `weight` union — Weight
          - integer
          - string
        - `deliveredWeight` union — Delivered weight
          - integer
          - string
      - `tasks` object[]
        - `_id` union — Task ID
          - integer
          - string

## Other responses

- `403` — Not authorized access

---

[API](https://skmtc.net/quadminds/apis/quadminds-api-v2.md) · [All operations](https://skmtc.net/quadminds/apis/quadminds-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/quadminds/quadminds-api-v2/versions/e0ab56dece05/schema)
