Attributes

ID

id Integer

ID for the identification

Order ID

orderID Integer

Order ID

Company ID

companyId Integer

Identification number for the company.

Admin ID

adminId Integer

Identification number for the admin.

Third Party Name

thirdPartyName String

Name of the third Party

Reference ID

referenceId String

Reference ID

Reference Tag

referenceTag String

Reference Tag

Third Party Fee

thirdPartyFee Double

Fee amount for third party

Shipday Charge

shipdayCharge Double

Charge amount of Shipday

Total Billable Amount

totalBillableAmount Double

Total Billable Amount

Charged

charged Boolean

Identifier if the amount is charged or not.

Timestamp

timestamp String, ISO DateTime, UTC

Current Time stamp

Pattern: YYYY-mm-DDTHH:MM:SSZ

Inserted At

insertedAt Long

Inserted At

Data

data String

Response Data

Tracking URL

trackingUrl String

Tracking URL

Driver Name

driverName String

Assigned Driver Name

Driver Phone

driverPhone String

Assigned Driver Phone number

Driver Location Latitude

driverLat Double

Driver location latitude value

Driver Location Longitude

driverLng Double

Driver Location Longitude value

Driver Image URL

driverImageUrl String

Driver Image URL

Driver Vehicle Description

driverVehicleDescription String

Driver Vehicle Description

Tip

tip Double

Tip amount for the driver

Processing Fee

processingFee Double

Processing Fee

Status

status String

One of the possible status enum values

Billable

billable Boolean

Identifier if it is billable

On Demand Delivery Object

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