Attributes


id Integer
ID for the identification


orderID Integer
Order ID


companyId Integer
Identification number for the company.


adminId Integer
Identification number for the admin.


thirdPartyName String
Name of the third Party


referenceId String
Reference ID


referenceTag String
Reference Tag


thirdPartyFee Double
Fee amount for third party


shipdayCharge Double
Charge amount of Shipday


totalBillableAmount Double
Total Billable Amount


charged Boolean
Identifier if the amount is charged or not.


timestamp String, ISO DateTime, UTC
Current Time stamp
Pattern: YYYY-mm-DDTHH:MM:SSZ


insertedAt Long
Inserted At


data String
Response Data


trackingUrl String
Tracking URL


driverName String
Assigned Driver Name


driverPhone String
Assigned Driver Phone number


driverLat Double
Driver location latitude value


driverLng Double
Driver Location Longitude value


driverImageUrl String
Driver Image URL


driverVehicleDescription String
Driver Vehicle Description


tip Double
Tip amount for the driver


processingFee Double
Processing Fee


status String
One of the possible status enum values

Possible enum values
REQUESTED
STARTED
PICKEDUP
DELIVERED
CANCELLED
FAILED

billable Boolean
Identifier if it is billable

{
  "id": 1233,
  "orderId": 123213,
  "companyId": 8836,
  "adminId": 3894,
  "thirdPartyName": "Delivery Ninja",
  "referenceId": "1231232",
  "referenceTag": "Third party",
  "thirdPartyFee": 1.50,
  "shipdayCharge": 1.25,
  "totalBillableAmount": 2.75,
  "charged": false,
  "timestamp": "2021-08-21T23:34:10Z",
  "insertedAt": 16232323232,
  "data": "Example information data",
  "trackingUrl": "https://dispatch.shipday.com/tracking/bHZu1221w==&lang=en",
  "driverName": "Alex",
  "driverPhone": "+14234420986",
  "driverLat": 32.8069245,
  "driverLng": -170.368697,
  "driverImageUrl": "https://s3-us-west-2.amazonaws.com/qt.com.dashboard.profile.driver/somelinktothecarrierphoto.jpg",
  "driverVehicleDescription": null,
  "tip": 4.50,
  "processingFee": 0.50,
  "status": "PICKEDUP",
  "billable": false
}