Update Job
This endpoint allows you to update some fields in the Nash job. Updating a job should always work before a quote is selected, but if a quote has been selected, Nash will return an error if the fleet rejects the update of the order.
Pre Dispatch Updates
Updating a job should always work before a quote is selected. Some updates may result in pricing changes
Please note that you are only able to update the package delivery times and the pickup or dropoff addresses before an order has been dispatched to a fleet. If any task in a job is dispatched and a delivery time or address are attempted to be updated, then an error will be thrown by the endpoint.
If you update any of the following fields, then the quotes returned by the job will be refreshed and the endpoint will return a new set of quotes. Moreover, any existing quotes (and quote IDs) will be invalid for dispatch. The fields that will force a refresh in the quotes:
- pickupAddress
- dropoffAddress
- packagePickupStartTime
- packagePickupEndTime
- packageDropoffStartTime
- packageDropoffEndTime
- packageDeliveryMode
- packageRequirements
- packageMinimumVehicleSize
- packageValue: for this field, it can also be updated in the post-dispatch stage
Note on Updating Times
If you wish to update the times of a Job, you must provide at least one time constraint out of packagePickupStartTime, packagePickupEndTime, packageDropoffStartTime, and packageDropoffEndTime. Times that are not specified will be calculated by Nash, and the previous times not included in the Update Request will be overwritten. Therefore, if you want to update only one time field and keep the rest the same, you must provide them in the parameters of the Update Request.
SCHEDULED job to NOW, you do not need to specify any other time fields.Post Dispatch Updates
If a quote has been selected or the job is dispatched via auto-dispatch, Nash will return an error if any of the assigned fleets in the job reject the update of the order.
In the post-dispatch stage, updating the package value of the job may result in a price change, based on how the providers calculate their pricing.
Below is a list of fields that are allowed to be updated, with more details on pre-dispatch or post-dispatch restrictions.
Path Parameters
job id
job configuration id
Body
Expected input for update job endpoint.
Pickup address
Pickup phone number
Pickup business name
Pickup first name
Pickup last name
Pickup email
Pickup instructions
Pickup store location ID
Dropoff address
Dropoff phone number
Dropoff business name
Dropoff first name
Dropoff last name
Dropoff email
Dropoff store location ID
Dropoff instructions
Package delivery mode
Package pickup start time
Package pickup end time
Package dropoff start time
Package dropoff end time
Package description
Package requirements
Package value
Package tax
Tip amount
Currency
External identifier
Items count
Job metadata
Reference ID