v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB

Job

Create Job

Create a new delivery job with pickup and dropoff details. A job represents a post-dispatch delivery request. Set quote_request_only=true to get price quotes without dispatching.

post/v1/jobs

Request body

pickupAddressstring nullable

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.

pickupLatitudenumber nullable

pickupLongitudenumber nullable

pickupBusinessNamestring nullable

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

pickupFirstNamestring nullable

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

pickupLastNamestring nullable

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

pickupPlaceIdstring nullable

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

pickupStoreLocationIdstring nullable

The Nash store location ID for the pickup location.

pickupPhoneNumberstring nullable

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

pickupEmailstring nullable

pickupBarcodesstring[] nullable

dropoffAddressstring nullable

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.

dropoffLatitudenumber nullable

dropoffLongitudenumber nullable

dropoffFirstNamestring nullable

dropoffLastNamestring nullable

dropoffPhoneNumberstring nullable

dropoffEmailstring nullable

dropoffStoreLocationIdstring nullable

dropoffExternalStoreLocationIdstring nullable

dropoffBarcodesstring[] nullable

packageDeliveryModestring required

pickupInstructionsstring nullable

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].

dropoffBusinessNamestring nullable

dropoffInstructionsstring nullable

dropoffPlaceIdstring nullable

packagePickupStartTimestring nullable

packagePickupEndTimestring nullable

packageDropoffStartTimestring nullable

packageDropoffEndTimestring nullable

packageDescriptionstring nullable

packageValuenumber nullable

packageValueCentsinteger nullable

tipAmountCentsinteger nullable

tipAmountUsdnumber nullable

currencystring nullable

packageExternalIdentifierstring nullable

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']

dimensionsobject nullable

packageItemsobject[] nullable

referenceIdstring nullable

externalIdentifierstring nullable

External identifier for the job.

optionsGroupIdstring nullable

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

jobMetadataobject nullable

Job metadata for the job.

inputDatetimesLocalizedToPickupTzboolean

Whether the input datetimes are localized to the pickup timezone.

quoteRequestOnlyboolean

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

Example request

{
  "pickupAddressComponents": {
    "number": "1600",
    "street": "Pennsylvania Avenue NW",
    "county": "Washington",
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "dropoffAddressComponents": {
    "number": "1600",
    "street": "Pennsylvania Avenue NW",
    "county": "Washington",
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "packageMinimumVehicleSize": "car",
  "packageRequirements": [
    "photo_proof_of_delivery",
    "age_verification_on_delivery"
  ],
  "externalIdentifier": "mini-mart-order-99",
  "optionsGroupId": "dss_1yMhHj",
  "jobMetadata": {
    "key": "value"
  }
}

Response

idstring required

Job ID

createdAtstring required

Created at

portalUrlstring required

Portal URL

externalIdentifierstring nullable

External identifier

jobMetadataobject nullable

Job metadata

isActiveboolean required

Is the job active

isBatchboolean required

Is the job a batch

shortReferenceCodestring nullable

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

selectedConfigurationobject nullable

Selected configuration

jobSpecificationobject nullable

Job specification