/vehicles/{id}/pick_up/

post

https://ship.cars/api/vehicles/{id}/pick_up/

Marks an identified vehicle as picked up.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique ID of the vehicle.

Body Params

timestamp

date-time

Date and time of completing the pickup/delivery process.

odometer_reading

string

Odometer reading of the vehicle as recorded by the driver.

full_name

string

length ≤ 64

Full name of the pickup/delivery contact who signed the BOL.

exceptions

string

length ≤ 1024

Additional notes about the exceptions added by the delivery contact.

driver_notes

string

length ≤ 1024

Driver's additional notes about the vehicle.

string

Email address specified by the pickup/delivery contact for receiving a copy of the load BOL.

dirty

boolean

Defaults to false

Indicates whether the vehicle is dirty at the time of pickup. This is specified by the driver as an inspection impediment.

night

boolean

Defaults to false

Indicates whether it's dark at the time of pickup. This is specified by the driver as an inspection impediment.

rain

boolean

Defaults to false

Indicates whether it's raining at the time of pickup. This is specified by the driver as an inspection impediment.

snow

boolean

Defaults to false

Indicates whether it's snowing at the time of pickup. This is specified by the driver as an inspection impediment.

location

object

GeoJSON Geometry object with the GPS coordinates of the actual pickup/delivery location.

signature_decline_reason

string

Unique slug of the configured reason given by the pickup/delivery contact for declining to sign the BOL.

uship_code

string

length ≤ 32

uShip payment code used for the vehicle.

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found