Route

Get route by id

get/Route/Id/{id}

Path parameters

idstring required

Response

A route

Codestring nullable

Route code/number

Idstring nullable

Unique identifier in user accounting system

Datestring date-time

Route date, yyyy-MM-dd

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

DriverNamestring nullable

Driver’s First Name and Last Name

DriverNumberinteger

Driver Number

DriverVehiclestring nullable

Vehicle license plate number

StartDatestring date-time nullable

Route start time

CloseDatestring date-time nullable

Route finish time

Tracknumber double nullable

Track distance, m

Priorityinteger nullable

Route priority

LocationLatnumber double nullable

Current GPS Latitude

LocationLonnumber double nullable

Current GPS Longitude

StartTimePlanstring date-time nullable

Planned Start Time

FinishTimePlanstring date-time nullable

Planned Finish Time

DistancePlannumber double nullable

Planned distance, m

CostPlannumber double nullable

Plan route cost

CostActualnumber double nullable

Actual route cost

CreateDateUtcstring date-time

Route creation date (UTC)

Status'Draft' | 'Ready' | 'Loaded' | 'InProgress' | 'Closed'

Xdboolean

Cross-Docking route

Example response

{
  "Code": "R0001234",
  "Id": "1234",
  "Date": "2019-02-01",
  "DepotId": "1",
  "Depot": "9 Riverside, Salford M7 1PA ",
  "StartFromDepot": true,
  "ReturnToDepot": true,
  "DriverLogin": "RT567 ",
  "DriverName": "Peter G.",
  "DriverNumber": 2,
  "DriverVehicle": "FCU 819",
  "StartDate": "2019-02-01T8:01:23",
  "CloseDate": "2019-02-01T18:32:47",
  "Track": 123158.1,
  "Priority": 99,
  "LocationLat": 25.290479,
  "LocationLon": 65.294049,
  "StartTimePlan": "2019-02-01T18:32:47",
  "FinishTimePlan": "2019-02-01T20:32:47",
  "DistancePlan": 12340,
  "CostPlan": 155.2,
  "CostActual": 165.32,
  "CreateDateUtc": "2019-02-01T13:32:47",
  "Orders": [
    {
      "Number": "cv30001-2",
      "Id": "10000345",
      "Date": "2019-02-01T00:00:00",
      "SeqNumber": 2,
      "RouteNumber": "R000123",
      "RoutePriority": 10,
      "DriverLogin": "ds45",
      "DriverName": "Dilan",
      "DriverNumber": 2,
      "DriverVehicle": "FCU 819",
      "ShipperId": "357",
      "Shipper": "Sanitex",
      "DepotId": "1",
      "Depot": "9 Riverside, Salford M7 1PA",
      "Weight": 50.5,
      "Volume": 8.54,
      "Pallets": 3.5,
      "InvoiceId": "inv0002 ",
      "CustomerReferenceId": "ord123/1",
      "GoodsList": [
        {
          "OrderLineId": "22435324",
          "GoodsId": "30495",
          "GoodsName": "Some big mystic box",
          "GoodsUnit": "pcs.",
          "Note": "ID3658AAA",
          "Quantity": 10.5,
          "QuantityFact": 9.5,
          "Cost": 2.99,
          "RejectReason": "Out Of Time",
          "HasPhoto": true,
          "Photos": [
            "https://image.track-pod.com/..."
          ],
          "OrderLineBarcode": "1234567890123",
          "GoodsBarcode": "1234567890123",
          "LoadStatus": "loaded",
          "LoadCheckScanRejectReason": "Barcode is Damaged",
          "ScanRejectReason": "Barcode is Damaged"
        }
      ],
      "PickupOrder": {
        "Date": "2019-02-01T00:00:00",
        "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_123",
            "Value": "Text Value"
          }
        ],
        "Note": "Only to sign Invoice",
        "COD": 20.45,
        "CODActual": "20.50",
        "StatusId": 3,
        "Status": "Delivered",
        "StatusLat": 25.290479,
        "DriverComment": "The customer was angry for being late",
        "RejectReason": "Out Of Time",
        "ScanRejectReason": "Barcode is Damaged",
        "LoadCheckScanRejectReason": "Barcode is Damaged",
        "SignatureName": "Andrew Bart",
        "HasSignaturePhoto": true,
        "SignaturePhotos": [
          "https://image.track-pod.com/..."
        ],
        "Photos": [
          "https://image.track-pod.com/..."
        ],
        "StatusDate": "2019-02-01T15:31:00",
        "ETA": "2019-02-01T15:27:00",
        "UpdatedETA": "2019-02-01T15:35:00",
        "RouteDate": "2019-02-01T00:00:00",
        "ArrivedDate": "2019-02-01T15:25:00",
        "DepartedDate": "2019-02-01T15:31:00",
        "ReportUrl": "Paid feature, please contact support for details",
        "Barcode": "1234567890123",
        "FeedbackRating": 5,
        "TrackKey": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
        "TrackId": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
        "TrackLink": "https://web.track-pod.com/track?id=d8662b19-ece7-4cda-baa3-c711ade5ad15",
        "LoadStatus": "loaded",
        "LoadDate": "2019-02-01T15:31:00",
        "AddressNote": "Beware of the dog",
        "ClientNote": "Very nice person",
        "RescheduledTimes": 1
      },
      "DistanceFromDepotPlan": 12340,
      "SeqNumberDriver": 2,
      "DeliveryInstructions": "Door code is 1234",
      "Pin": "1234",
      "AddressNote": "Beware of the dog",
      "ClientNote": "Very nice person",
      "CreateDateUtc": "2019-02-01T13:32:47",
      "Feedback": "Great service!",
      "RouteDate": "2019-02-01T00:00:00",
      "ClientId": "247",
      "Client": "Maxima",
      "AddressId": "13587",
      "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",
      "COD": 20.45,
      "CODActual": "20.50",
      "StatusId": 3,
      "Status": "Delivered",
      "StatusLat": 25.290479,
      "DriverComment": "The customer was angry for being late",
      "RejectReason": "Out Of Time",
      "LoadCheckScanRejectReason": "Barcode is Damaged",
      "ScanRejectReason": "Barcode is Damaged",
      "SignatureName": "Andrew Bart",
      "HasSignaturePhoto": true,
      "SignaturePhotos": [
        "https://image.track-pod.com/..."
      ],
      "Photos": [
        "https://image.track-pod.com/..."
      ],
      "StatusDate": "2019-02-01T15:31:00",
      "ETA": "2019-02-01T15:27:00",
      "UpdatedETA": "2019-02-01T15:35:00",
      "ArrivedDate": "2019-02-01T15:25:00",
      "DepartedDate": "2019-02-01T15:31:00",
      "ReportUrl": "Paid feature, please contact support for details",
      "CustomFields": [
        {
          "Id": "cf_123",
          "Value": "Text Value"
        }
      ],
      "Barcode": "1234567890123",
      "FeedbackRating": 5,
      "TrackKey": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
      "TrackId": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
      "TrackLink": "https://web.track-pod.com/track?id=d8662b19-ece7-4cda-baa3-c711ade5ad15",
      "LoadStatus": "loaded",
      "LoadDate": "2019-02-01T15:31:00",
      "RescheduledTimes": 1
    }
  ],
  "Vehicle": {
    "Number": "XXX777",
    "CarrierCode": "31",
    "Carrier": "Big Logistics",
    "Weight": 10000,
    "Volume": 14.5,
    "Pallets": 16
  },
  "CustomFields": [
    {
      "Id": "cf_123",
      "Value": "Text Value"
    }
  ]
}

Changes

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

Aug 26, 20262ff1d587e26e5See the full diff
- ○
  added the optional property Orders/items/PickupOrder/Date to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/Date to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/Date to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/Date to the response with the 200 status (media type: application/xml)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/Date to the response with the 200 status (media type: text/xml)
  response-optional-property-added
Aug 21, 20261d1f234240a36010See the full diff
- ●
  removed the optional property Orders/items/PickupOrder/CancelledStatus from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CancelledStatus from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CancelledStatus from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CancelledStatus from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CancelledStatus from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CustomFieldsStr from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CustomFieldsStr from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CustomFieldsStr from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CustomFieldsStr from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/CustomFieldsStr from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasLoadSignature from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasLoadSignature from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasLoadSignature from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasLoadSignature from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasLoadSignature from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasRoutePointPhoto from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasRoutePointPhoto from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasRoutePointPhoto from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasRoutePointPhoto from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/HasRoutePointPhoto from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/Id_DocShipment from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/Id_DocShipment from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/Id_DocShipment from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/Id_DocShipment from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/Id_DocShipment from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadCheckScanReasonId from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadCheckScanReasonId from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadCheckScanReasonId from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadCheckScanReasonId from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadCheckScanReasonId from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadStatusId from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadStatusId from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadStatusId from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadStatusId from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/LoadStatusId from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanServiceTime from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanServiceTime from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanServiceTime from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanServiceTime from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanServiceTime from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTime from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTime from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTime from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTime from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTime from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTimeDep from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTimeDep from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTimeDep from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTimeDep from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/PlanTimeDep from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/RejectReasonId from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/RejectReasonId from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/RejectReasonId from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/RejectReasonId from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/RejectReasonId from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/ScanReasonId from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/ScanReasonId from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/ScanReasonId from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/ScanReasonId from the response with the 200 status (media type: application/xml)
  response-optional-property-removed
- ●
  removed the optional property Orders/items/PickupOrder/ScanReasonId from the response with the 200 status (media type: text/xml)
  response-optional-property-removed
- ○
  added the optional property Orders/items/PickupOrder/ViaHub to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/ViaHub to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/ViaHub to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/ViaHub to the response with the 200 status (media type: application/xml)
  response-optional-property-added
- ○
  added the optional property Orders/items/PickupOrder/ViaHub to the response with the 200 status (media type: text/xml)
  response-optional-property-added
- ○
  added the optional property Orders/items/ViaHub to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property Orders/items/ViaHub to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property Orders/items/ViaHub to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property Orders/items/ViaHub to the response with the 200 status (media type: application/xml)
  response-optional-property-added
- ○
  added the optional property Orders/items/ViaHub to the response with the 200 status (media type: text/xml)
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history