v1

latestOpenAPI 3.1.02026-07-2413054.9 KB

Assign

Assign to a specific 3rd party delivery service provider. Usually, after getting an estimate.

post/assign

Headers

Authorizationstring required

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

Content-Typestring required

Request body

namestring required

Name of the 3rd party service provider

orderIdinteger required

Order id of the order to be assigned

tipnumber double

Tip amount for the order

estimateReferencestring

Reference id of the estimate

contactlessDeliveryboolean

Boolean value indicating contactless delivery or not

podType'"PHOTO"' | '"SIGNATURE"' | '"PIN"' | '"NONE"'

Enum values ("PHOTO", "SIGNATURE", "PIN", "NONE") indicating proof of delivery type

podTypesstring[]

If multiple POD types are applicable, then it can be sent in this property as an array of enum POD types like ["PHOTO", "PIN"]

Response

200

idinteger

orderIdinteger

companyIdinteger

adminIdinteger

thirdPartyNamestring

referenceIdstring

referenceTagstring

thirdPartyFeenumber

shipdayChargenumber

totalBillableAmountnumber

chargedboolean

timestampstring

insertedAtinteger

datastring

trackingUrlstring

driverNamestring

driverPhonestring

driverLatnumber

driverLngnumber

driverImageUrlstring

{"stackTrail":"paths:/assign:post:responses:200:content:application/json:schema:properties:driverVehicleDescription","oasType":"schema","type":"unknown"}

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