Skip to main content
POST
Create or Update Job by External Identifier
This endpoint is deprecated. Please use the Create or Update Order by External Identifier endpoint instead.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

externalIdentifier
string
required

job external identifier

Body

application/json

Expected payload for creating a job and optionally autodispatch.

packageDeliveryMode
string
required
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
ParsedAddressInputSerializer · 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
ParsedAddressInputSerializer · 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
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
Pattern: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?
packagePickupEndTime
string | null
Pattern: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?
packageDropoffStartTime
string | null
Pattern: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?
packageDropoffEndTime
string | null
Pattern: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?
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
enum<string>

Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']

Available options:
any,
bike,
motorbike,
cargobike,
sedan,
car,
suv,
pickup_truck,
pickup,
van,
large_van,
extra_large_van,
truck
Example:

"car"

packageRequirements
(enum<string> | string)[] | null

Package requirements.

Available options:
photo_proof_of_delivery,
signature_proof_of_delivery,
photo_proof_of_pickup,
photo_reference_on_dropoff,
photo_reference_capture_on_dropoff,
signature_proof_of_pickup,
photo_pre_delivery_verification,
age_verification_on_delivery,
id_verification_on_delivery,
barcode_scan_on_pickup,
barcode_scan_on_dropoff,
barcode_scan_on_return,
meet_on_delivery,
shipping_label,
two_person_team,
pincode_verification,
schedule_ii_controlled_substances,
alcohol,
tobacco,
vapes,
parking_check_in,
display_barcode_on_pickup,
pick_and_pack
Example:
weight
dimensions
Dimensions · object | null
packageItems
Packageitems · object[] | null
referenceId
string | null
externalIdentifier
string | null

External identifier for the job.

Example:

"mini-mart-order-99"

optionsGroupId
string | null

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

Example:

"dss_1yMhHj"

jobMetadata
Jobmetadata · object | null

Job metadata for the job.

Example:
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

OK

A Nash Job.

id
string
required

Job ID

Example:

"job_01234567890"

createdAt
string
required

Created at

Example:

"2023-08-29T19:17:46.264523"

portalUrl
string
required

Portal URL

Example:

"https://usenash.com/portal/job_abc123"

isActive
boolean
required

Is the job active

Example:

true

isBatch
boolean
required

Is the job a batch

Example:

false

jobConfigurations
JobConfigurationsSerializer · object[]
required

Job configurations

externalIdentifier
string | null

External identifier

Example:

"mini-mart-order-99"

jobMetadata
Jobmetadata · object | null

Job metadata

Example:
optionsGroup
OptionsGroupSerializer · object | null

Options group

shortReferenceCode
string | null

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

Example:

"0123456"

selectedConfiguration
Selectedconfiguration · object | null
deprecated

Selected configuration

Example:
jobSpecification
Jobspecification · object | null
deprecated

Job specification

Example:
route
RouteSerializer · object | null

Route