Route

Add route

post/Route

Query parameters

updateboolean

Add or remove orders from the route if route already exists on this date.

updateAddressGpsboolean

Force update existing Lat/Lon in the Addresses directory from the payload data.

mergeAddressesboolean

Merge orders by address onto one site

updateGoodsPriceboolean

Force update existing Price in the Goods directory from the payload data.

Request body

Codestring nullable

Route code/number

Idstring nullable

Unique identifier in user accounting system

Datestring date-time nullable

Route date, yyyy-MM-dd

StartTimePlanstring date-time nullable

Planned Start Time, yyyy-MM-ddTHH:mm:ss or HH:mm

DepotIdstring nullable

Unique identifier in user accounting system

Depotstring nullable

Depot address

StartFromDepotboolean nullable

Start route from depot

ReturnToDepotboolean nullable

Return to depot

DriverLoginstring nullable

Driver's login

DriverPasswordstring nullable

Driver’s password

DriverNamestring nullable

Driver’s First Name and Last Name

DriverVehiclestring nullable

Driver’s vehicle license plate number

Example request

{
  "Code": "R0001234",
  "Id": "1234",
  "Date": "2019-02-01",
  "StartTimePlan": "13:00",
  "DepotId": "1",
  "Depot": "9 Riverside, Salford M7 1PA",
  "StartFromDepot": true,
  "ReturnToDepot": true,
  "DriverLogin": "RT567 ",
  "DriverPassword": "1",
  "DriverName": "Peter G.",
  "DriverVehicle": "FCU 819",
  "Vehicle": {
    "Number": "XXX777",
    "CarrierCode": "31",
    "Carrier": "Big Logistics",
    "Weight": 10000,
    "Volume": 14.5,
    "Pallets": 16
  },
  "Orders": [
    {
      "Number": "cv30001-2",
      "Id": "10000345",
      "Date": "2019-02-01",
      "Shipper": "Sanitex",
      "Depot": "9 Riverside, Salford M7 1PA ",
      "Client": "Maxima",
      "Address": "2 St Josephs Crescent, Liverpool L3 3JF",
      "AddressLat": 25.290479,
      "AddressLon": 65.294049,
      "AddressZone": "Zone 1",
      "TimeSlotFrom": "2019-02-01T09:00:00",
      "TimeSlotTo": "2019-02-01T18:00:00",
      "ServiceTime": 10,
      "Note": "Only to sign Invoice",
      "ContactName": "John Doe",
      "Phone": "+37061191244",
      "Email": "X-604@maxima.com",
      "Weight": 50.5,
      "Volume": 8.54,
      "Pallets": 3.5,
      "COD": 20.45,
      "InvoiceId": "inv0002 ",
      "CustomerReferenceId": "ord123/1",
      "Barcode": "1234567890123",
      "ShipperId": "357",
      "DepotId": "1",
      "ClientId": "247",
      "AddressId": "13587",
      "GoodsList": [
        {
          "OrderLineId": "22435324",
          "GoodsId": "30495",
          "GoodsName": "Some big mystic box",
          "GoodsUnit": "pcs.",
          "Note": "ID3658AAA",
          "Quantity": 10.5,
          "Cost": 2.99,
          "OrderLineBarcode": "1234567890123",
          "GoodsBarcode": "1234567890123"
        }
      ],
      "CustomFields": [
        {
          "Id": "cf_456"
        }
      ],
      "PickupOrder": {
        "Date": "2019-02-03",
        "ClientId": "247",
        "Client": "Maxima",
        "AddressId": "13587",
        "Address": "2 St Josephs Crescent, Liverpool L3 3JF",
        "AddressLat": 25.290479,
        "AddressLon": 65.294049,
        "AddressZone": "Zone 1",
        "ContactName": "John Doe",
        "Phone": "+37061191244",
        "Email": "X-604@maxima.com",
        "TimeSlotFrom": "2019-02-01T09:00:00",
        "TimeSlotTo": "2019-02-01T18:00:00",
        "ServiceTime": 10,
        "CustomFields": [
          {
            "Id": "cf_456"
          }
        ],
        "COD": 20.45,
        "Note": "Only to sign Invoice"
      }
    }
  ],
  "CustomFields": [
    {
      "Id": "cf_456"
    }
  ]
}

Response

Route was created successfully

Statusinteger nullable

The HTTP status code for the response

Titlestring nullable

A short, human-readable summary of the response

Detailstring nullable

A human-readable explanation specific to this response.

Changes

Changed in 2 of the 3 revisions of this API.4

Aug 26, 20262ff1d587e26e2See the full diff
- ○
  added the new optional request property Orders/items/PickupOrder/Date (media type: application/json)
  new-optional-request-property
- ○
  added the new optional request property Orders/items/PickupOrder/Date (media type: application/xml)
  new-optional-request-property
Aug 21, 20261d1f234240a32See the full diff
- ○
  added the new optional request property Orders/items/ViaHub (media type: application/json)
  new-optional-request-property
- ○
  added the new optional request property Orders/items/ViaHub (media type: application/xml)
  new-optional-request-property
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history