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

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

isActive
boolean
required

Is the job active

isBatch
boolean
required

Is the job a batch

jobConfigurations
object[]
required

Job configurations

externalIdentifier
string | null

External identifier

jobMetadata
object | null

Job metadata

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