PATCH
/
v1
/
jobs
/
{jobId}
/
{jobConfigurationId}

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:

  1. pickupAddress
  2. dropoffAddress
  3. packagePickupStartTime
  4. packagePickupEndTime
  5. packageDropoffStartTime
  6. packageDropoffEndTime
  7. packageDeliveryMode
  8. packageRequirements
  9. packageMinimumVehicleSize
  10. 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.

If you change a packageDeliveryMode=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

jobId
string
required

job id

jobConfigurationId
string | null
required

job configuration id

Body

application/json

Expected input for update job endpoint.

pickupAddress
string | null

Pickup address

pickupPhoneNumber
string | null

Pickup phone number

pickupBusinessName
string | null

Pickup business name

pickupFirstName
string | null

Pickup first name

pickupLastName
string | null

Pickup last name

pickupEmail
string | null

Pickup email

pickupInstructions
string | null

Pickup instructions

pickupStoreLocationId
string | null

Pickup store location ID

dropoffAddress
string | null

Dropoff address

dropoffPhoneNumber
string | null

Dropoff phone number

dropoffBusinessName
string | null

Dropoff business name

dropoffFirstName
string | null

Dropoff first name

dropoffLastName
string | null

Dropoff last name

dropoffEmail
string | null

Dropoff email

dropoffStoreLocationId
string | null

Dropoff store location ID

dropoffInstructions
string | null

Dropoff instructions

packageDeliveryMode
string | null

Package delivery mode

packagePickupStartTime
string | null

Package pickup start time

packagePickupEndTime
string | null

Package pickup end time

packageDropoffStartTime
string | null

Package dropoff start time

packageDropoffEndTime
string | null

Package dropoff end time

packageDescription
string | null

Package description

packageRequirements
string[] | null

Package requirements

packageValue
number | null

Package value

packageTax
number | null

Package tax

tipAmount
number | null

Tip amount

currency
string | null

Currency

externalIdentifier
string | null

External identifier

itemsCount
integer | null

Items count

jobMetadata
object | null

Job metadata

referenceId
string | null

Reference ID

Response

200 - application/json

A Nash Job.

id
string
required

Job ID

createdAt
string
required

Created at

portalUrl
string
required

Portal URL

externalIdentifier
string | null

External identifier

jobMetadata
object | null

Job metadata

isActive
boolean
required

Is the job active

isBatch
boolean
required

Is the job a batch

jobConfigurations
object[]
required

Job configurations

optionsGroup
object | null

Options group

shortReferenceCode
string | null

7-digit non-unique human-readable reference code for the job.

selectedConfiguration
object | null
deprecated

Selected configuration

jobSpecification
object | null
deprecated

Job specification