Scheduled Job Time Calculations
When creating a scheduled job, you must include at least one of the following fields:packagePickupStartTime
packagePickupEndTime
packageDropoffStartTime
packageDropoffEndTime
null
.Package Items
An array of item objects, each describing an item within the package for delivery. Each object should include the item’s name, dimensions (length, width, height), and count, providing a detailed inventory of the package’s contents. This information is used to ensure accurate handling and space allocation for transport.
selectedConfiguration
and jobSpecification
returned in the job response are deprecated and not recommended to be used.Migration guide, replace:jobSpecification->package
with data->jobConfiguration[0]->package
and selectedConfiguration
with jobConfiguration[0]
Body
Expected payload for creating a job.
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.
Parsed address input serializer for creating a job.
Pickup business name at the origin. Limited to 80 characters.
First name of the person to pickup from. If unknown pass "Manager". Limited to 80 characters.
Last name of the person to pickup from. If unknown pass "Manager". Limited to 80 characters.
The Google place ID for the pickup location.If passed, resolving the pickup location's lat/lng will happen with this field.
The Nash store location ID for the pickup location.
The phone number to contact at the location in the form: "+15555555555"
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.
Parsed address input serializer for creating a job.
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].
Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'truck', 'large_van', 'extra_large_van']
any
, bike
, motorbike
, cargobike
, sedan
, car
, suv
, pickup_truck
, pickup
, van
, truck
, large_van
, extra_large_van
"car"
Package requirements.
[
"photo_proof_of_delivery",
"age_verification_on_delivery"
]
External identifier for the job.
"mini-mart-order-99"
Dispatch strategy ID (formerly known as options group ID) for the job.
"dss_1yMhHj"
Job metadata for the job.
{ "key": "value" }
Whether the input datetimes are localized to the pickup timezone.
Whether to only request a quote and not create a job.
Response
OK
A Nash Job.
Job ID
"job_01234567890"
Created at
"2023-08-29T19:17:46.264523"
Portal URL
"https://usenash.com/portal/job_abc123"
Is the job active
true
Is the job a batch
false
Job configurations
External identifier
"mini-mart-order-99"
Job metadata
{ "key": "value" }
Options group Generic serializer for options groups used in many endpoints.
7-digit non-unique human-readable reference code for the job.
"0123456"
Selected configuration
{ "tasks": [] }
Job specification
{ "packages": [] }