POST
/
v1
/
jobs
/
external_identifier
/
{externalIdentifier}

Path Parameters

externalIdentifier
string
required

job external identifier

Body

application/json

Expected payload for creating a job and optionally autodispatch.

pickupAddress
string | null

The full address in one line for the pickup location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code], [country]. All address fields are required except "second line". Second line should include Apt/Suite/Unit/# appended to the number of the unit.

pickupAddressComponents
object | null

Parsed address input serializer for creating a job.

pickupLatitude
number | null
pickupLongitude
number | null
pickupBusinessName
string | null

Pickup business name at the origin. Limited to 80 characters.

pickupFirstName
string | null

First name of the person to pickup from. If unknown pass "Manager". Limited to 80 characters.

pickupLastName
string | null

Last name of the person to pickup from. If unknown pass "Manager". Limited to 80 characters.

pickupPlaceId
string | null

The Google place ID for the pickup location.If passed, resolving the pickup location's lat/lng will happen with this field.

pickupStoreLocationId
string | null

The Nash store location ID for the pickup location.

pickupPhoneNumber
string | null

The phone number to contact at the location in the form: "+15555555555"

pickupEmail
string | null
pickupBarcodes
string[] | null
dropoffAddress
string | null

The full address in one line for the dropoff location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state], [zip code], [country]. All address fields are required except "second line". Second line should include Apt/Suite/Unit/# appended to the number of the unit.

dropoffAddressComponents
object | null

Parsed address input serializer for creating a job.

dropoffLatitude
number | null
dropoffLongitude
number | null
dropoffFirstName
string | null
dropoffLastName
string | null
dropoffPhoneNumber
string | null
dropoffEmail
string | null
dropoffStoreLocationId
string | null
dropoffExternalStoreLocationId
string | null
dropoffBarcodes
string[] | null
packageDeliveryMode
string
required
pickupInstructions
string | null

Any special instructions for pickup. Limited to 280 characters. Nash Recommended Input: Pickup order [insert order number] for [insert customer name] from [pickup business name].

dropoffBusinessName
string | null
dropoffInstructions
string | null
dropoffPlaceId
string | null
packagePickupStartTime
string | null
packagePickupEndTime
string | null
packageDropoffStartTime
string | null
packageDropoffEndTime
string | null
packageDescription
string | null
packageValue
number | null
packageValueCents
integer | null
packageTax
packageServiceFee
tipAmount
tipAmountCents
integer | null
tipAmountUsd
number | null
currency
string | null
itemsCount
packageExternalIdentifier
string | null
packageMinimumVehicleSize
string | null
packageRequirements
(enum<string> | string)[] | null

Package requirements.

Available options:
photo_proof_of_delivery,
signature_proof_of_delivery,
photo_proof_of_pickup,
signature_proof_of_pickup,
age_verification_on_delivery,
id_verification_on_delivery,
barcode_scan_on_pickup,
barcode_scan_on_dropoff,
meet_on_delivery,
shipping_label,
two_person_team,
pincode_verification,
schedule_ii_controlled_substances,
alcohol,
parking_check_in
weight
dimensions
object | null
packageItems
object[] | null
referenceId
string | null
externalIdentifier
string | null

External identifier for the job.

optionsGroupId
string | null

Dispatch strategy ID (formerly known as options group ID) for the job.

jobMetadata
object | null

Job metadata for the job.

inputDatetimesLocalizedToPickupTz
boolean
default: false

Whether the input datetimes are localized to the pickup timezone.

quoteRequestOnly
boolean
default: false

Whether to only request a quote and not create a job.

autodispatch
boolean
default: false

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