Returns

Returns On-demand delivery details object

Returns

name

• Type: string
  Required: Yes
  Defaults to: null
  Name of the 3rd party service provider

orderId

• Type: int32
  Required: Yes
  Defaults to: null
  Order id of the order to be assigned

tip

• Type: double
  Defaults to: null
  Tip amount for the order

estimateReference

• Type: string
  Defaults to: null
  Reference id of the estimate

contactlessDelivery

• Type: boolean
  Defaults to: false
  Boolean value indicating contactless delivery or not

podType

• Type: string
  Enum: Defaults to null
  Enum values ("PHOTO", "SIGNATURE", "PIN", "NONE") indicating proof of delivery type
  Allowed:
  "PHOTO" "SIGNATURE" "PIN" "NONE"

podTypes

• Type: array of strings
  Defaults to: null
  If multiple POD types are applicable, then it can be sent in this property as an array of enum POD types like ["PHOTO", "PIN"]

Example Request

curl --request POST \
     --url https://api.shipday.com/on-demand/assign \
     --header 'Accept: application/json' \
     --header 'Authorization: Basic BgxsDwd00n.LNNn90QydrjgZ1K9dS13' \
     --header 'Content-Type: application/json' \
     --data '{
     "name": "Hello Orders",
     "orderId": 1234,
     "tip": 6.5,
     "estimateReference": "12345",
     "contactlessDelivery": false,
     "podType": "PHOTO"
}'

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,
  "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.5,
  "processingFee": 0.5,
  "status": "PICKEDUP",
  "billable": false
}