v1

latestOpenAPI 3.0.42026-08-067441330.9 KB

Order

Get order by Id

get/Order/Id/{id}

Path parameters

idstring required

Response

An order

Numberstring nullable

Order/Invoice/Job/Waybill number

Idstring nullable

Unique identifier in user accounting system

Datestring date-time

Order date, yyyy-MM-dd

SeqNumberinteger nullable

Scheduled sequence in the route

RouteNumberstring nullable

Route number

RoutePriorityinteger nullable

Route priority

RouteStatus'Draft' | 'Ready' | 'Loaded' | 'InProgress' | 'Closed'

DriverLoginstring nullable

DriverNamestring nullable

Name of Driver

DriverNumberinteger nullable

Driver Number

DriverVehiclestring nullable

Vehicle license plate number

ShipperIdstring nullable

Unique identifier in user accounting system

Shipperstring nullable

Shipper/Supplier name

DepotIdstring nullable

Unique identifier in user accounting system

Depotstring nullable

Depot address

Weightnumber double

Total weight

Volumenumber double

Total volume

Palletsnumber double

Pallets count

InvoiceIdstring nullable

Invoice identifier in user accounting system

CustomerReferenceIdstring nullable

Customer reference order identifier in user accounting system

DistanceFromDepotPlannumber double nullable

Planned distance from depot, m

SeqNumberDriverinteger nullable

Updated sequence by driver in the route

DeliveryInstructionsstring nullable

Delivery Instructions from live-tracking page

Pinstring nullable

Confirmation pin code

AddressNotestring nullable

Address note

ClientNotestring nullable

Client note

CreateDateUtcstring date-time

Order creation date (UTC)

Prioritystring nullable

Priority values: low, normal, high

TeamCodestring nullable

Team code

Feedbackstring nullable

Feedback

RouteDatestring date-time nullable

Route date

Typeinteger

Order type: 0 - Delivery order; 1 - Collection order

ClientIdstring nullable

Unique identifier in user accounting system

Clientstring nullable

Client/Customer name

AddressIdstring nullable

Unique identifier in user accounting system

Addressstring nullable

Delivery/Pickup address

AddressLatnumber double nullable

Address GPS Latitude

AddressLonnumber double nullable

Address GPS Longitude

AddressZonestring nullable

Address zone

TimeSlotFromstring date-time nullable

Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss

TimeSlotTostring date-time nullable

Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss

ServiceTimenumber double nullable

Desired service time, min. If seconds are specified value will be decimal

Notestring nullable

Notes to order

ContactNamestring nullable

Customer’s contact name

Phonestring nullable

Customer’s contact phone number

Emailstring nullable

Customer’s e-mail

CODnumber double

Amount of Cash on Delivery

CODActualstring nullable

Collected Paid Amount from a Client

StatusIdinteger nullable

Status code: 1 - In Progress; 2 - Not delivered/Not collected (site issues); 3 - Delivered/Collected; 4 - Partially; 5 - Not delivered/Not collected (order issues)

Statusstring nullable

Status description

StatusLatnumber double nullable

Status GPS Latitude

StatusLonnumber double nullable

Status GPS Longitude

DriverCommentstring nullable

Drivers comment from mobile application

RejectReasonstring nullable

Reject reason for order

LoadCheckScanRejectReasonstring nullable

Reject reason for order's scanning when the order is loaded

ScanRejectReasonstring nullable

Reject reason for order's scanning

SignatureNamestring nullable

Name of the person who signed

HasSignaturePhotoboolean nullable

Signature attached

SignaturePhotosstring[] nullable

Array of links for download jpg file (each link is available for 24h from API call)

HasPhotoboolean nullable

Photo attached

Photosstring[] nullable

Array of links for download jpg file (each link is available for 24h from API call)

StatusDatestring date-time nullable

Status date

ETAstring date-time nullable

Estimated time of arrival

UpdatedETAstring date-time nullable

Updated estimated time of arrival

ArrivedDatestring date-time nullable

Date of arrival

DepartedDatestring date-time nullable

Date of Departure

ReportUrlstring nullable

Link to the PDF order delivery note (available within 1 hour from the API call)

Barcodestring nullable

Barcode

Scannedboolean nullable

Order is scanned in the mobile application

FeedbackRatingnumber double nullable

Feedback Rating from mobile application

TrackKeystring uuid

Key for tracking order

TrackIdstring uuid

Id for tracking order

TrackLinkstring nullable

Link for tracking order

LoadStatusstring nullable

Status code: none; loaded; not-loaded;

LoadDatestring date-time nullable

Date of Loading

LoadSignaturePhotosstring[] nullable

Array of links for download jpg file (each link is available for 24h from API call)

ChangeDatestring date-time

RescheduledTimesinteger nullable

Order rescheduled times

Example response

{
  "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": {
    "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
}