Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Disposition|Tour

Create/Update tours.

This method can be used to create and update tours. To modify or add stops within tours use the /tour/upsert_stop endpoint.

An attempt is made to find an existing tour based on the selected primary key. If one is found, it will be adjusted. Otherwise, a new tour is created.

post/tour/upsert

Request body

deleteMissingboolean

Do you want to delete all tours missing from this request?

dryRunboolean

Simulate the operation. (No records will be created or changed) This Parameter is optional.

Example request

{
  "records": [
    {
      "data": {
        "startDate": "2015-02-20"
      }
    }
  ]
}

Response

Success Response:

Example response

{
  "createdTours": [
    {
      "startDate": "2015-02-20",
      "stops": [
        {
          "latLng": [
            52.38127828631681,
            7.594243214018696
          ],
          "eta": "2015-02-20T12:59:21+01:00",
          "etd": "2015-02-20T12:59:21+01:00",
          "ata": "2015-02-20T12:59:21+01:00",
          "atd": "2015-02-20T12:59:21+01:00",
          "orders": [
            {
              "createdAt": "2015-02-20T12:59:21+01:00"
            }
          ]
        }
      ],
      "startTime": "2015-02-20T12:59:21+01:00",
      "endTime": "2015-02-20T12:59:21+01:00"
    }
  ],
  "updatedTours": [
    {
      "startDate": "2015-02-20",
      "stops": [
        {
          "latLng": [
            52.38127828631681,
            7.594243214018696
          ],
          "eta": "2015-02-20T12:59:21+01:00",
          "etd": "2015-02-20T12:59:21+01:00",
          "ata": "2015-02-20T12:59:21+01:00",
          "atd": "2015-02-20T12:59:21+01:00",
          "orders": [
            {
              "createdAt": "2015-02-20T12:59:21+01:00"
            }
          ]
        }
      ],
      "startTime": "2015-02-20T12:59:21+01:00",
      "endTime": "2015-02-20T12:59:21+01:00"
    }
  ],
  "deletedTours": [
    {
      "startDate": "2015-02-20",
      "stops": [
        {
          "latLng": [
            52.38127828631681,
            7.594243214018696
          ],
          "eta": "2015-02-20T12:59:21+01:00",
          "etd": "2015-02-20T12:59:21+01:00",
          "ata": "2015-02-20T12:59:21+01:00",
          "atd": "2015-02-20T12:59:21+01:00",
          "orders": [
            {
              "createdAt": "2015-02-20T12:59:21+01:00"
            }
          ]
        }
      ],
      "startTime": "2015-02-20T12:59:21+01:00",
      "endTime": "2015-02-20T12:59:21+01:00"
    }
  ]
}