Details

Get order and status details for an assigned order to 3rd party service provider.

get/details/{orderId}

Request

Base URL
https://api.shipday.com/on-demand
URL
https://api.shipday.com/on-demand/details/{orderId}
Auth
API key in header Authorization

Path parameters

orderIdstring required

order Id of the order

Headers

Authorizationstring required

Replace the BgxsDwd00n.LNNn90QydrjgZ1K9dS13 part with your own API_KEY from Shipday for authentication.

Content-Typestring required

Response

200

idinteger

orderIdinteger

companyIdinteger

adminIdinteger

thirdPartyNamestring

referenceIdstring

referenceTagstring

thirdPartyFeenumber

shipdayChargenumber

totalBillableAmountnumber

chargedboolean

timestampstring

insertedAtinteger

datastring

trackingUrlstring

driverNamestring

driverPhonestring

driverLatnumber

driverLngnumber

driverImageUrlstring

driverVehicleDescriptionunknown

tipnumber

processingFeenumber

statusstring

billableboolean

Example response

{
  "id": 1233,
  "orderId": 123213,
  "companyId": 8836,
  "adminId": 3894,
  "thirdPartyName": "Delivery Ninja",
  "referenceId": "1231232",
  "referenceTag": "Third party",
  "thirdPartyFee": 1.5,
  "shipdayCharge": 1.25,
  "totalBillableAmount": 2.75,
  "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",
  "tip": 4.5,
  "processingFee": 0.5,
  "status": "PICKEDUP"
}

Changes

No recorded changes to this operation across all 1 revision of this API.