Skip to main content
POST
/
v1
/
jobs
Create Job
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "packageDeliveryMode": "<string>",
  "pickupAddress": "<string>",
  "pickupAddressComponents": {
    "street": "Pennsylvania Avenue NW",
    "city": "Washington",
    "country": "US",
    "number": "1600",
    "secondaryNumber": null,
    "county": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "pickupLatitude": 123,
  "pickupLongitude": 123,
  "pickupBusinessName": "<string>",
  "pickupFirstName": "<string>",
  "pickupLastName": "<string>",
  "pickupPlaceId": "<string>",
  "pickupStoreLocationId": "<string>",
  "pickupPhoneNumber": "<string>",
  "pickupEmail": "<string>",
  "pickupBarcodes": [
    "<string>"
  ],
  "dropoffAddress": "<string>",
  "dropoffAddressComponents": {
    "street": "Pennsylvania Avenue NW",
    "city": "Washington",
    "country": "US",
    "number": "1600",
    "secondaryNumber": null,
    "county": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "dropoffLatitude": 123,
  "dropoffLongitude": 123,
  "dropoffFirstName": "<string>",
  "dropoffLastName": "<string>",
  "dropoffPhoneNumber": "<string>",
  "dropoffEmail": "<string>",
  "dropoffStoreLocationId": "<string>",
  "dropoffExternalStoreLocationId": "<string>",
  "dropoffBarcodes": [
    "<string>"
  ],
  "pickupInstructions": "<string>",
  "dropoffBusinessName": "<string>",
  "dropoffInstructions": "<string>",
  "dropoffPlaceId": "<string>",
  "packagePickupStartTime": "<string>",
  "packagePickupEndTime": "<string>",
  "packageDropoffStartTime": "<string>",
  "packageDropoffEndTime": "<string>",
  "packageDescription": "<string>",
  "packageValue": 123,
  "packageValueCents": 123,
  "packageTax": 123,
  "packageServiceFee": 123,
  "tipAmount": 123,
  "tipAmountCents": 123,
  "tipAmountUsd": 123,
  "currency": "<string>",
  "itemsCount": 123,
  "packageExternalIdentifier": "<string>",
  "packageMinimumVehicleSize": "car",
  "packageRequirements": [
    "photo_proof_of_delivery",
    "age_verification_on_delivery"
  ],
  "weight": 123,
  "dimensions": {},
  "packageItems": [
    {}
  ],
  "referenceId": "<string>",
  "externalIdentifier": "mini-mart-order-99",
  "optionsGroupId": "dss_1yMhHj",
  "jobMetadata": {
    "key": "value"
  },
  "inputDatetimesLocalizedToPickupTz": false,
  "quoteRequestOnly": false
}
'
import requests

url = "https://api.sandbox.usenash.com/v1/jobs"

payload = {
    "packageDeliveryMode": "<string>",
    "pickupAddress": "<string>",
    "pickupAddressComponents": {
        "street": "Pennsylvania Avenue NW",
        "city": "Washington",
        "country": "US",
        "number": "1600",
        "secondaryNumber": None,
        "county": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "latitude": 38.8948949,
        "longitude": -77.0371581
    },
    "pickupLatitude": 123,
    "pickupLongitude": 123,
    "pickupBusinessName": "<string>",
    "pickupFirstName": "<string>",
    "pickupLastName": "<string>",
    "pickupPlaceId": "<string>",
    "pickupStoreLocationId": "<string>",
    "pickupPhoneNumber": "<string>",
    "pickupEmail": "<string>",
    "pickupBarcodes": ["<string>"],
    "dropoffAddress": "<string>",
    "dropoffAddressComponents": {
        "street": "Pennsylvania Avenue NW",
        "city": "Washington",
        "country": "US",
        "number": "1600",
        "secondaryNumber": None,
        "county": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "latitude": 38.8948949,
        "longitude": -77.0371581
    },
    "dropoffLatitude": 123,
    "dropoffLongitude": 123,
    "dropoffFirstName": "<string>",
    "dropoffLastName": "<string>",
    "dropoffPhoneNumber": "<string>",
    "dropoffEmail": "<string>",
    "dropoffStoreLocationId": "<string>",
    "dropoffExternalStoreLocationId": "<string>",
    "dropoffBarcodes": ["<string>"],
    "pickupInstructions": "<string>",
    "dropoffBusinessName": "<string>",
    "dropoffInstructions": "<string>",
    "dropoffPlaceId": "<string>",
    "packagePickupStartTime": "<string>",
    "packagePickupEndTime": "<string>",
    "packageDropoffStartTime": "<string>",
    "packageDropoffEndTime": "<string>",
    "packageDescription": "<string>",
    "packageValue": 123,
    "packageValueCents": 123,
    "packageTax": 123,
    "packageServiceFee": 123,
    "tipAmount": 123,
    "tipAmountCents": 123,
    "tipAmountUsd": 123,
    "currency": "<string>",
    "itemsCount": 123,
    "packageExternalIdentifier": "<string>",
    "packageMinimumVehicleSize": "car",
    "packageRequirements": ["photo_proof_of_delivery", "age_verification_on_delivery"],
    "weight": 123,
    "dimensions": {},
    "packageItems": [{}],
    "referenceId": "<string>",
    "externalIdentifier": "mini-mart-order-99",
    "optionsGroupId": "dss_1yMhHj",
    "jobMetadata": { "key": "value" },
    "inputDatetimesLocalizedToPickupTz": False,
    "quoteRequestOnly": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    packageDeliveryMode: '<string>',
    pickupAddress: '<string>',
    pickupAddressComponents: {
      street: 'Pennsylvania Avenue NW',
      city: 'Washington',
      country: 'US',
      number: '1600',
      secondaryNumber: null,
      county: 'Washington',
      state: 'DC',
      postalCode: '20500',
      latitude: 38.8948949,
      longitude: -77.0371581
    },
    pickupLatitude: 123,
    pickupLongitude: 123,
    pickupBusinessName: '<string>',
    pickupFirstName: '<string>',
    pickupLastName: '<string>',
    pickupPlaceId: '<string>',
    pickupStoreLocationId: '<string>',
    pickupPhoneNumber: '<string>',
    pickupEmail: '<string>',
    pickupBarcodes: ['<string>'],
    dropoffAddress: '<string>',
    dropoffAddressComponents: {
      street: 'Pennsylvania Avenue NW',
      city: 'Washington',
      country: 'US',
      number: '1600',
      secondaryNumber: null,
      county: 'Washington',
      state: 'DC',
      postalCode: '20500',
      latitude: 38.8948949,
      longitude: -77.0371581
    },
    dropoffLatitude: 123,
    dropoffLongitude: 123,
    dropoffFirstName: '<string>',
    dropoffLastName: '<string>',
    dropoffPhoneNumber: '<string>',
    dropoffEmail: '<string>',
    dropoffStoreLocationId: '<string>',
    dropoffExternalStoreLocationId: '<string>',
    dropoffBarcodes: ['<string>'],
    pickupInstructions: '<string>',
    dropoffBusinessName: '<string>',
    dropoffInstructions: '<string>',
    dropoffPlaceId: '<string>',
    packagePickupStartTime: '<string>',
    packagePickupEndTime: '<string>',
    packageDropoffStartTime: '<string>',
    packageDropoffEndTime: '<string>',
    packageDescription: '<string>',
    packageValue: 123,
    packageValueCents: 123,
    packageTax: 123,
    packageServiceFee: 123,
    tipAmount: 123,
    tipAmountCents: 123,
    tipAmountUsd: 123,
    currency: '<string>',
    itemsCount: 123,
    packageExternalIdentifier: '<string>',
    packageMinimumVehicleSize: 'car',
    packageRequirements: ['photo_proof_of_delivery', 'age_verification_on_delivery'],
    weight: 123,
    dimensions: {},
    packageItems: [{}],
    referenceId: '<string>',
    externalIdentifier: 'mini-mart-order-99',
    optionsGroupId: 'dss_1yMhHj',
    jobMetadata: {key: 'value'},
    inputDatetimesLocalizedToPickupTz: false,
    quoteRequestOnly: false
  })
};

fetch('https://api.sandbox.usenash.com/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.usenash.com/v1/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'packageDeliveryMode' => '<string>',
    'pickupAddress' => '<string>',
    'pickupAddressComponents' => [
        'street' => 'Pennsylvania Avenue NW',
        'city' => 'Washington',
        'country' => 'US',
        'number' => '1600',
        'secondaryNumber' => null,
        'county' => 'Washington',
        'state' => 'DC',
        'postalCode' => '20500',
        'latitude' => 38.8948949,
        'longitude' => -77.0371581
    ],
    'pickupLatitude' => 123,
    'pickupLongitude' => 123,
    'pickupBusinessName' => '<string>',
    'pickupFirstName' => '<string>',
    'pickupLastName' => '<string>',
    'pickupPlaceId' => '<string>',
    'pickupStoreLocationId' => '<string>',
    'pickupPhoneNumber' => '<string>',
    'pickupEmail' => '<string>',
    'pickupBarcodes' => [
        '<string>'
    ],
    'dropoffAddress' => '<string>',
    'dropoffAddressComponents' => [
        'street' => 'Pennsylvania Avenue NW',
        'city' => 'Washington',
        'country' => 'US',
        'number' => '1600',
        'secondaryNumber' => null,
        'county' => 'Washington',
        'state' => 'DC',
        'postalCode' => '20500',
        'latitude' => 38.8948949,
        'longitude' => -77.0371581
    ],
    'dropoffLatitude' => 123,
    'dropoffLongitude' => 123,
    'dropoffFirstName' => '<string>',
    'dropoffLastName' => '<string>',
    'dropoffPhoneNumber' => '<string>',
    'dropoffEmail' => '<string>',
    'dropoffStoreLocationId' => '<string>',
    'dropoffExternalStoreLocationId' => '<string>',
    'dropoffBarcodes' => [
        '<string>'
    ],
    'pickupInstructions' => '<string>',
    'dropoffBusinessName' => '<string>',
    'dropoffInstructions' => '<string>',
    'dropoffPlaceId' => '<string>',
    'packagePickupStartTime' => '<string>',
    'packagePickupEndTime' => '<string>',
    'packageDropoffStartTime' => '<string>',
    'packageDropoffEndTime' => '<string>',
    'packageDescription' => '<string>',
    'packageValue' => 123,
    'packageValueCents' => 123,
    'packageTax' => 123,
    'packageServiceFee' => 123,
    'tipAmount' => 123,
    'tipAmountCents' => 123,
    'tipAmountUsd' => 123,
    'currency' => '<string>',
    'itemsCount' => 123,
    'packageExternalIdentifier' => '<string>',
    'packageMinimumVehicleSize' => 'car',
    'packageRequirements' => [
        'photo_proof_of_delivery',
        'age_verification_on_delivery'
    ],
    'weight' => 123,
    'dimensions' => [
        
    ],
    'packageItems' => [
        [
                
        ]
    ],
    'referenceId' => '<string>',
    'externalIdentifier' => 'mini-mart-order-99',
    'optionsGroupId' => 'dss_1yMhHj',
    'jobMetadata' => [
        'key' => 'value'
    ],
    'inputDatetimesLocalizedToPickupTz' => false,
    'quoteRequestOnly' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.usenash.com/v1/jobs"

	payload := strings.NewReader("{\n  \"packageDeliveryMode\": \"<string>\",\n  \"pickupAddress\": \"<string>\",\n  \"pickupAddressComponents\": {\n    \"street\": \"Pennsylvania Avenue NW\",\n    \"city\": \"Washington\",\n    \"country\": \"US\",\n    \"number\": \"1600\",\n    \"secondaryNumber\": null,\n    \"county\": \"Washington\",\n    \"state\": \"DC\",\n    \"postalCode\": \"20500\",\n    \"latitude\": 38.8948949,\n    \"longitude\": -77.0371581\n  },\n  \"pickupLatitude\": 123,\n  \"pickupLongitude\": 123,\n  \"pickupBusinessName\": \"<string>\",\n  \"pickupFirstName\": \"<string>\",\n  \"pickupLastName\": \"<string>\",\n  \"pickupPlaceId\": \"<string>\",\n  \"pickupStoreLocationId\": \"<string>\",\n  \"pickupPhoneNumber\": \"<string>\",\n  \"pickupEmail\": \"<string>\",\n  \"pickupBarcodes\": [\n    \"<string>\"\n  ],\n  \"dropoffAddress\": \"<string>\",\n  \"dropoffAddressComponents\": {\n    \"street\": \"Pennsylvania Avenue NW\",\n    \"city\": \"Washington\",\n    \"country\": \"US\",\n    \"number\": \"1600\",\n    \"secondaryNumber\": null,\n    \"county\": \"Washington\",\n    \"state\": \"DC\",\n    \"postalCode\": \"20500\",\n    \"latitude\": 38.8948949,\n    \"longitude\": -77.0371581\n  },\n  \"dropoffLatitude\": 123,\n  \"dropoffLongitude\": 123,\n  \"dropoffFirstName\": \"<string>\",\n  \"dropoffLastName\": \"<string>\",\n  \"dropoffPhoneNumber\": \"<string>\",\n  \"dropoffEmail\": \"<string>\",\n  \"dropoffStoreLocationId\": \"<string>\",\n  \"dropoffExternalStoreLocationId\": \"<string>\",\n  \"dropoffBarcodes\": [\n    \"<string>\"\n  ],\n  \"pickupInstructions\": \"<string>\",\n  \"dropoffBusinessName\": \"<string>\",\n  \"dropoffInstructions\": \"<string>\",\n  \"dropoffPlaceId\": \"<string>\",\n  \"packagePickupStartTime\": \"<string>\",\n  \"packagePickupEndTime\": \"<string>\",\n  \"packageDropoffStartTime\": \"<string>\",\n  \"packageDropoffEndTime\": \"<string>\",\n  \"packageDescription\": \"<string>\",\n  \"packageValue\": 123,\n  \"packageValueCents\": 123,\n  \"packageTax\": 123,\n  \"packageServiceFee\": 123,\n  \"tipAmount\": 123,\n  \"tipAmountCents\": 123,\n  \"tipAmountUsd\": 123,\n  \"currency\": \"<string>\",\n  \"itemsCount\": 123,\n  \"packageExternalIdentifier\": \"<string>\",\n  \"packageMinimumVehicleSize\": \"car\",\n  \"packageRequirements\": [\n    \"photo_proof_of_delivery\",\n    \"age_verification_on_delivery\"\n  ],\n  \"weight\": 123,\n  \"dimensions\": {},\n  \"packageItems\": [\n    {}\n  ],\n  \"referenceId\": \"<string>\",\n  \"externalIdentifier\": \"mini-mart-order-99\",\n  \"optionsGroupId\": \"dss_1yMhHj\",\n  \"jobMetadata\": {\n    \"key\": \"value\"\n  },\n  \"inputDatetimesLocalizedToPickupTz\": false,\n  \"quoteRequestOnly\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.sandbox.usenash.com/v1/jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"packageDeliveryMode\": \"<string>\",\n  \"pickupAddress\": \"<string>\",\n  \"pickupAddressComponents\": {\n    \"street\": \"Pennsylvania Avenue NW\",\n    \"city\": \"Washington\",\n    \"country\": \"US\",\n    \"number\": \"1600\",\n    \"secondaryNumber\": null,\n    \"county\": \"Washington\",\n    \"state\": \"DC\",\n    \"postalCode\": \"20500\",\n    \"latitude\": 38.8948949,\n    \"longitude\": -77.0371581\n  },\n  \"pickupLatitude\": 123,\n  \"pickupLongitude\": 123,\n  \"pickupBusinessName\": \"<string>\",\n  \"pickupFirstName\": \"<string>\",\n  \"pickupLastName\": \"<string>\",\n  \"pickupPlaceId\": \"<string>\",\n  \"pickupStoreLocationId\": \"<string>\",\n  \"pickupPhoneNumber\": \"<string>\",\n  \"pickupEmail\": \"<string>\",\n  \"pickupBarcodes\": [\n    \"<string>\"\n  ],\n  \"dropoffAddress\": \"<string>\",\n  \"dropoffAddressComponents\": {\n    \"street\": \"Pennsylvania Avenue NW\",\n    \"city\": \"Washington\",\n    \"country\": \"US\",\n    \"number\": \"1600\",\n    \"secondaryNumber\": null,\n    \"county\": \"Washington\",\n    \"state\": \"DC\",\n    \"postalCode\": \"20500\",\n    \"latitude\": 38.8948949,\n    \"longitude\": -77.0371581\n  },\n  \"dropoffLatitude\": 123,\n  \"dropoffLongitude\": 123,\n  \"dropoffFirstName\": \"<string>\",\n  \"dropoffLastName\": \"<string>\",\n  \"dropoffPhoneNumber\": \"<string>\",\n  \"dropoffEmail\": \"<string>\",\n  \"dropoffStoreLocationId\": \"<string>\",\n  \"dropoffExternalStoreLocationId\": \"<string>\",\n  \"dropoffBarcodes\": [\n    \"<string>\"\n  ],\n  \"pickupInstructions\": \"<string>\",\n  \"dropoffBusinessName\": \"<string>\",\n  \"dropoffInstructions\": \"<string>\",\n  \"dropoffPlaceId\": \"<string>\",\n  \"packagePickupStartTime\": \"<string>\",\n  \"packagePickupEndTime\": \"<string>\",\n  \"packageDropoffStartTime\": \"<string>\",\n  \"packageDropoffEndTime\": \"<string>\",\n  \"packageDescription\": \"<string>\",\n  \"packageValue\": 123,\n  \"packageValueCents\": 123,\n  \"packageTax\": 123,\n  \"packageServiceFee\": 123,\n  \"tipAmount\": 123,\n  \"tipAmountCents\": 123,\n  \"tipAmountUsd\": 123,\n  \"currency\": \"<string>\",\n  \"itemsCount\": 123,\n  \"packageExternalIdentifier\": \"<string>\",\n  \"packageMinimumVehicleSize\": \"car\",\n  \"packageRequirements\": [\n    \"photo_proof_of_delivery\",\n    \"age_verification_on_delivery\"\n  ],\n  \"weight\": 123,\n  \"dimensions\": {},\n  \"packageItems\": [\n    {}\n  ],\n  \"referenceId\": \"<string>\",\n  \"externalIdentifier\": \"mini-mart-order-99\",\n  \"optionsGroupId\": \"dss_1yMhHj\",\n  \"jobMetadata\": {\n    \"key\": \"value\"\n  },\n  \"inputDatetimesLocalizedToPickupTz\": false,\n  \"quoteRequestOnly\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.usenash.com/v1/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"packageDeliveryMode\": \"<string>\",\n  \"pickupAddress\": \"<string>\",\n  \"pickupAddressComponents\": {\n    \"street\": \"Pennsylvania Avenue NW\",\n    \"city\": \"Washington\",\n    \"country\": \"US\",\n    \"number\": \"1600\",\n    \"secondaryNumber\": null,\n    \"county\": \"Washington\",\n    \"state\": \"DC\",\n    \"postalCode\": \"20500\",\n    \"latitude\": 38.8948949,\n    \"longitude\": -77.0371581\n  },\n  \"pickupLatitude\": 123,\n  \"pickupLongitude\": 123,\n  \"pickupBusinessName\": \"<string>\",\n  \"pickupFirstName\": \"<string>\",\n  \"pickupLastName\": \"<string>\",\n  \"pickupPlaceId\": \"<string>\",\n  \"pickupStoreLocationId\": \"<string>\",\n  \"pickupPhoneNumber\": \"<string>\",\n  \"pickupEmail\": \"<string>\",\n  \"pickupBarcodes\": [\n    \"<string>\"\n  ],\n  \"dropoffAddress\": \"<string>\",\n  \"dropoffAddressComponents\": {\n    \"street\": \"Pennsylvania Avenue NW\",\n    \"city\": \"Washington\",\n    \"country\": \"US\",\n    \"number\": \"1600\",\n    \"secondaryNumber\": null,\n    \"county\": \"Washington\",\n    \"state\": \"DC\",\n    \"postalCode\": \"20500\",\n    \"latitude\": 38.8948949,\n    \"longitude\": -77.0371581\n  },\n  \"dropoffLatitude\": 123,\n  \"dropoffLongitude\": 123,\n  \"dropoffFirstName\": \"<string>\",\n  \"dropoffLastName\": \"<string>\",\n  \"dropoffPhoneNumber\": \"<string>\",\n  \"dropoffEmail\": \"<string>\",\n  \"dropoffStoreLocationId\": \"<string>\",\n  \"dropoffExternalStoreLocationId\": \"<string>\",\n  \"dropoffBarcodes\": [\n    \"<string>\"\n  ],\n  \"pickupInstructions\": \"<string>\",\n  \"dropoffBusinessName\": \"<string>\",\n  \"dropoffInstructions\": \"<string>\",\n  \"dropoffPlaceId\": \"<string>\",\n  \"packagePickupStartTime\": \"<string>\",\n  \"packagePickupEndTime\": \"<string>\",\n  \"packageDropoffStartTime\": \"<string>\",\n  \"packageDropoffEndTime\": \"<string>\",\n  \"packageDescription\": \"<string>\",\n  \"packageValue\": 123,\n  \"packageValueCents\": 123,\n  \"packageTax\": 123,\n  \"packageServiceFee\": 123,\n  \"tipAmount\": 123,\n  \"tipAmountCents\": 123,\n  \"tipAmountUsd\": 123,\n  \"currency\": \"<string>\",\n  \"itemsCount\": 123,\n  \"packageExternalIdentifier\": \"<string>\",\n  \"packageMinimumVehicleSize\": \"car\",\n  \"packageRequirements\": [\n    \"photo_proof_of_delivery\",\n    \"age_verification_on_delivery\"\n  ],\n  \"weight\": 123,\n  \"dimensions\": {},\n  \"packageItems\": [\n    {}\n  ],\n  \"referenceId\": \"<string>\",\n  \"externalIdentifier\": \"mini-mart-order-99\",\n  \"optionsGroupId\": \"dss_1yMhHj\",\n  \"jobMetadata\": {\n    \"key\": \"value\"\n  },\n  \"inputDatetimesLocalizedToPickupTz\": false,\n  \"quoteRequestOnly\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": "job_01234567890",
  "createdAt": "2023-08-29T19:17:46.264523",
  "portalUrl": "https://usenash.com/portal/job_abc123",
  "isActive": true,
  "isBatch": false,
  "jobConfigurations": [
    {
      "id": "cfg_01234567890",
      "package": {
        "id": "pkg_01234567890",
        "requirements": [
          "photo_proof_of_delivery",
          "age_verification_on_delivery"
        ],
        "valueCents": 123,
        "itemsCount": 100,
        "pickupLocation": {
          "id": "loc_01234567890",
          "address": "1600 Amphitheatre Parkway",
          "formattedAddress": "1600 Amphitheatre Parkway",
          "addressCity": "Mountain View",
          "addressCountry": "US",
          "timezoneId": "America/Los_Angeles",
          "timezoneName": "Pacific Time",
          "addressNumber": "1600",
          "addressFormattedStreet": "Amphitheatre Parkway",
          "addressCounty": "Santa Clara",
          "addressState": "CA",
          "addressZip": "94043",
          "instructions": "Turn left on Main St",
          "businessName": "Nash",
          "firstName": "John",
          "lastName": "Doe",
          "phoneNumber": "+15555555555",
          "email": "john.doe@example.com",
          "lat": 37.774929,
          "lng": -122.419416
        },
        "dropoffLocation": {
          "id": "loc_01234567890",
          "address": "1600 Amphitheatre Parkway",
          "formattedAddress": "1600 Amphitheatre Parkway",
          "addressCity": "Mountain View",
          "addressCountry": "US",
          "timezoneId": "America/Los_Angeles",
          "timezoneName": "Pacific Time",
          "addressNumber": "1600",
          "addressFormattedStreet": "Amphitheatre Parkway",
          "addressCounty": "Santa Clara",
          "addressState": "CA",
          "addressZip": "94043",
          "instructions": "Turn left on Main St",
          "businessName": "Nash",
          "firstName": "John",
          "lastName": "Doe",
          "phoneNumber": "+15555555555",
          "email": "john.doe@example.com",
          "lat": 37.774929,
          "lng": -122.419416
        },
        "description": "Package description",
        "tags": [
          "Alcohol"
        ],
        "packageDeliveryMode": "now",
        "pickupStartTime": "2021-01-01T00:00:00Z",
        "pickupEndTime": "2021-01-01T00:00:00Z",
        "pickupBarcodes": [
          "<string>"
        ],
        "dropoffStartTime": "2021-01-01T00:00:00Z",
        "dropoffEndTime": "2021-01-01T00:00:00Z",
        "dropoffBarcodes": [
          "<string>"
        ],
        "taxCents": 100,
        "serviceFeeCents": 100,
        "externalIdentifier": "mini-mart-order-99",
        "minimumVehicleSize": "car",
        "pickupStoreLocationId": "store_01234567890",
        "pickupStoreLocationExternalId": "0123",
        "dropoffStoreLocationId": "store_01234567890",
        "drivingMetrics": {
          "distance": 100,
          "duration": 100
        },
        "value": 100,
        "tax": 100,
        "serviceFee": 100,
        "tipAmountCents": 123,
        "weight": 100,
        "dimensions": {
          "height": 100,
          "length": 100,
          "width": 100
        },
        "items": [
          {
            "count": 1,
            "description": "Item 1",
            "valueCents": 100
          }
        ],
        "referenceId": "mini-mart-order-99",
        "packageMetadata": {
          "key": "value"
        }
      },
      "tasks": [
        {
          "id": "tsk_01234567890",
          "createdAt": "2023-08-29T19:17:46.264523",
          "status": "running",
          "pickupStartTime": "2023-08-29T19:17:46.264523",
          "pickupEndTime": "2023-08-29T19:17:46.264523",
          "dropoffStartTime": "2023-08-29T19:17:46.264523",
          "dropoffEndTime": "2023-08-29T19:17:46.264523",
          "providerId": "prv_01234567890",
          "providerIsInternal": true,
          "tipAmountCents": 100,
          "winnerQuote": {
            "id": "qot_01234567890",
            "price_cents": 100
          },
          "quotes": [
            {
              "id": "qot_01234567890",
              "price_cents": 100
            }
          ],
          "failedQuotes": [
            {
              "id": "qot_01234567890",
              "price_cents": 100
            }
          ],
          "delivery": {
            "id": "dlv_01234567890",
            "status": "dropoff_complete",
            "isActive": true,
            "priceCents": 123,
            "currency": "<string>",
            "type": "<string>",
            "statusHistory": [
              {
                "created_at": "2023-08-29T19:17:46.264523",
                "status": "created"
              },
              {
                "created_at": "2023-08-29T19:17:47.509265",
                "status": "not_assigned_driver"
              }
            ],
            "pickupEta": "<string>",
            "dropoffEta": "<string>",
            "dropoffDeadline": "<string>",
            "documents": [
              {
                "createdAt": "<string>",
                "id": "<string>",
                "type": "<string>",
                "contentType": "<string>",
                "url": "<string>",
                "data": "<string>",
                "documentMetadata": {}
              }
            ],
            "nashFeeCents": 123,
            "courierName": "<string>",
            "courierPhoneNumber": "<string>",
            "courierPickupPhoneNumber": "<string>",
            "courierDropoffPhoneNumber": "<string>",
            "courierLocation": {},
            "courierVehicle": {},
            "courierProfileImage": "<string>",
            "proofOfDelivery": [
              {}
            ],
            "providerDeliveryId": "<string>",
            "providerBatchId": "<string>",
            "price": 123,
            "taxAmountCents": 123,
            "tollFeeCents": 123,
            "waitFeeCents": 123,
            "waitTimeMinutes": 123,
            "cancellationFeeCents": 123,
            "returnFeeCents": 123,
            "otherProviderFees": {},
            "insuranceFeeCents": 123,
            "totalPriceBreakdown": {},
            "totalPriceCents": 123,
            "pickedItems": [
              {
                "sku": "<string>",
                "requestedSku": "<string>",
                "id": "<string>",
                "requestedId": "<string>",
                "quantity": 123,
                "requestedQuantity": 123,
                "scannedBarcode": "<string>",
                "weight": 123,
                "priceCents": 123,
                "status": "<string>",
                "name": "<string>",
                "scans": [
                  {
                    "substitutionType": "<string>",
                    "barcodes": [
                      {
                        "weight": 123,
                        "priceCents": 123,
                        "weightUnit": "<string>",
                        "productCode": "<string>",
                        "isVariableWeight": true,
                        "barcode": "<string>",
                        "variableValue": 123,
                        "format": "<string>",
                        "indicatorDigit": "<string>",
                        "checkDigit": "<string>",
                        "manufacturerCode": "<string>",
                        "itemReference": "<string>",
                        "pluCheckDigit": "<string>",
                        "barcodeSansCheckDigit": "<string>",
                        "expirationDate": "<string>"
                      }
                    ]
                  }
                ]
              }
            ]
          },
          "tipAmountUsd": 100,
          "failureReason": "Task failed",
          "taskNotes": [
            {
              "created_at": "2023-08-29T19:17:46.264523",
              "id": "not_01234567890",
              "note": "Task note",
              "user": {
                "email": "john.doe@example.com"
              }
            }
          ]
        }
      ],
      "advancedTask": {
        "id": "tsk_01234567890",
        "createdAt": "2023-08-29T19:17:46.264523",
        "status": "running",
        "pickupStartTime": "2023-08-29T19:17:46.264523",
        "pickupEndTime": "2023-08-29T19:17:46.264523",
        "dropoffStartTime": "2023-08-29T19:17:46.264523",
        "dropoffEndTime": "2023-08-29T19:17:46.264523",
        "providerId": "prv_01234567890",
        "providerIsInternal": true,
        "tipAmountCents": 100,
        "winnerQuote": {
          "id": "qot_01234567890",
          "price_cents": 100
        },
        "quotes": [
          {
            "id": "qot_01234567890",
            "price_cents": 100
          }
        ],
        "failedQuotes": [
          {
            "id": "qot_01234567890",
            "price_cents": 100
          }
        ],
        "delivery": {
          "id": "dlv_01234567890",
          "status": "dropoff_complete",
          "isActive": true,
          "priceCents": 123,
          "currency": "<string>",
          "type": "<string>",
          "statusHistory": [
            {
              "created_at": "2023-08-29T19:17:46.264523",
              "status": "created"
            },
            {
              "created_at": "2023-08-29T19:17:47.509265",
              "status": "not_assigned_driver"
            }
          ],
          "pickupEta": "<string>",
          "dropoffEta": "<string>",
          "dropoffDeadline": "<string>",
          "documents": [
            {
              "createdAt": "<string>",
              "id": "<string>",
              "type": "<string>",
              "contentType": "<string>",
              "url": "<string>",
              "data": "<string>",
              "documentMetadata": {}
            }
          ],
          "nashFeeCents": 123,
          "courierName": "<string>",
          "courierPhoneNumber": "<string>",
          "courierPickupPhoneNumber": "<string>",
          "courierDropoffPhoneNumber": "<string>",
          "courierLocation": {},
          "courierVehicle": {},
          "courierProfileImage": "<string>",
          "proofOfDelivery": [
            {}
          ],
          "providerDeliveryId": "<string>",
          "providerBatchId": "<string>",
          "price": 123,
          "taxAmountCents": 123,
          "tollFeeCents": 123,
          "waitFeeCents": 123,
          "waitTimeMinutes": 123,
          "cancellationFeeCents": 123,
          "returnFeeCents": 123,
          "otherProviderFees": {},
          "insuranceFeeCents": 123,
          "totalPriceBreakdown": {},
          "totalPriceCents": 123,
          "pickedItems": [
            {
              "sku": "<string>",
              "requestedSku": "<string>",
              "id": "<string>",
              "requestedId": "<string>",
              "quantity": 123,
              "requestedQuantity": 123,
              "scannedBarcode": "<string>",
              "weight": 123,
              "priceCents": 123,
              "status": "<string>",
              "name": "<string>",
              "scans": [
                {
                  "substitutionType": "<string>",
                  "barcodes": [
                    {
                      "weight": 123,
                      "priceCents": 123,
                      "weightUnit": "<string>",
                      "productCode": "<string>",
                      "isVariableWeight": true,
                      "barcode": "<string>",
                      "variableValue": 123,
                      "format": "<string>",
                      "indicatorDigit": "<string>",
                      "checkDigit": "<string>",
                      "manufacturerCode": "<string>",
                      "itemReference": "<string>",
                      "pluCheckDigit": "<string>",
                      "barcodeSansCheckDigit": "<string>",
                      "expirationDate": "<string>"
                    }
                  ]
                }
              ]
            }
          ]
        },
        "tipAmountUsd": 100,
        "failureReason": "Task failed",
        "taskNotes": [
          {
            "created_at": "2023-08-29T19:17:46.264523",
            "id": "not_01234567890",
            "note": "Task note",
            "user": {
              "email": "john.doe@example.com"
            }
          }
        ]
      },
      "delivery": {
        "id": "dlv_01234567890",
        "status": "dropoff_complete",
        "isActive": true,
        "priceCents": 123,
        "currency": "<string>",
        "type": "<string>",
        "statusHistory": [
          {
            "created_at": "2023-08-29T19:17:46.264523",
            "status": "created"
          },
          {
            "created_at": "2023-08-29T19:17:47.509265",
            "status": "not_assigned_driver"
          }
        ],
        "pickupEta": "<string>",
        "dropoffEta": "<string>",
        "dropoffDeadline": "<string>",
        "documents": [
          {
            "createdAt": "<string>",
            "id": "<string>",
            "type": "<string>",
            "contentType": "<string>",
            "url": "<string>",
            "data": "<string>",
            "documentMetadata": {}
          }
        ],
        "nashFeeCents": 123,
        "courierName": "<string>",
        "courierPhoneNumber": "<string>",
        "courierPickupPhoneNumber": "<string>",
        "courierDropoffPhoneNumber": "<string>",
        "courierLocation": {},
        "courierVehicle": {},
        "courierProfileImage": "<string>",
        "proofOfDelivery": [
          {}
        ],
        "providerDeliveryId": "<string>",
        "providerBatchId": "<string>",
        "price": 123,
        "taxAmountCents": 123,
        "tollFeeCents": 123,
        "waitFeeCents": 123,
        "waitTimeMinutes": 123,
        "cancellationFeeCents": 123,
        "returnFeeCents": 123,
        "otherProviderFees": {},
        "insuranceFeeCents": 123,
        "totalPriceBreakdown": {},
        "totalPriceCents": 123,
        "pickedItems": [
          {
            "sku": "<string>",
            "requestedSku": "<string>",
            "id": "<string>",
            "requestedId": "<string>",
            "quantity": 123,
            "requestedQuantity": 123,
            "scannedBarcode": "<string>",
            "weight": 123,
            "priceCents": 123,
            "status": "<string>",
            "name": "<string>",
            "scans": [
              {
                "substitutionType": "<string>",
                "barcodes": [
                  {
                    "weight": 123,
                    "priceCents": 123,
                    "weightUnit": "<string>",
                    "productCode": "<string>",
                    "isVariableWeight": true,
                    "barcode": "<string>",
                    "variableValue": 123,
                    "format": "<string>",
                    "indicatorDigit": "<string>",
                    "checkDigit": "<string>",
                    "manufacturerCode": "<string>",
                    "itemReference": "<string>",
                    "pluCheckDigit": "<string>",
                    "barcodeSansCheckDigit": "<string>",
                    "expirationDate": "<string>"
                  }
                ]
              }
            ]
          }
        ]
      },
      "publicTrackingUrl": "https://usenash.com/tracking/job_abc123"
    }
  ],
  "externalIdentifier": "mini-mart-order-99",
  "jobMetadata": {
    "key": "value"
  },
  "optionsGroup": {
    "id": "opn_WyMhHj",
    "label": "New York City Strategy",
    "allowedProviders": [
      "prv_01234567890",
      "prv_01234567891"
    ],
    "enableAutoDispatch": true,
    "providerSelectionStrategy": "cheapest",
    "reassignOnFailure": true,
    "enableMaxDeliveryFee": true,
    "maxDeliveryFeeCents": 10000,
    "costSplitMaxFixedPriceCents": 10000,
    "costSplitMaxPercentage": 0.1,
    "costSplitStrategy": "price",
    "smartReassignment": true
  },
  "shortReferenceCode": "0123456",
  "selectedConfiguration": {
    "tasks": []
  },
  "jobSpecification": {
    "packages": []
  },
  "route": {
    "id": "rte_JphRWDiEosGpXuxwgaYfY3",
    "portalUrl": "https://portal.usenash.com/routes/rte_JphRWDiEosGpXuxwgaYfY3",
    "type": "SINGLE_PICKUP_MULTIPLE_DROPOFFS",
    "stops": [
      {
        "stopType": "PICKUP",
        "objectIds": [
          "ord_Qr5bVt8WiByGh66z2g7xEu",
          "ord_WJFuooSiRvFCaceGZjpbqs"
        ],
        "location": {
          "lat": 45.558214,
          "lng": -122.587074
        },
        "arrivalTime": "2025-04-25T03:27:00",
        "departTime": "2025-04-25T03:30:00",
        "plannedArrivalTime": "2025-04-25T03:27:00",
        "serviceTime": 360,
        "distanceFromPrevious": 3376,
        "durationFromPrevious": 420,
        "status": "PENDING",
        "statusDescription": "leave_unattended",
        "statusHistory": [
          {
            "created_at": "2025-04-25T03:00:00Z",
            "status": "PENDING"
          },
          {
            "created_at": "2025-04-25T03:15:00Z",
            "status": "ENROUTE"
          },
          {
            "created_at": "2025-04-25T03:20:00Z",
            "status": "COMPLETED",
            "status_description": "leave_unattended"
          }
        ],
        "metadata": {},
        "startedAt": "2025-04-25T03:27:00Z",
        "breakDuration": 123,
        "orders": [
          {
            "id": "ord_Qr5bVt8WiByGh66z2g7xEu",
            "externalId": "<string>",
            "publicTrackingUrl": "<string>",
            "pod": [
              {
                "type": "<string>",
                "url": "<string>",
                "uploadedAt": "<string>"
              }
            ],
            "orderItems": [
              {
                "id": "item-001",
                "description": "<string>",
                "count": 123,
                "valueCents": 123,
                "barcode": "<string>",
                "sku": "<string>",
                "category": "<string>",
                "status": "delivered",
                "availableQuantity": 123,
                "statusMetadata": {
                  "pickedAt": "<string>",
                  "deliveredAt": "<string>",
                  "failedAt": "<string>",
                  "returnedAt": "<string>",
                  "failureReason": "<string>",
                  "failureLocation": "dropoff"
                },
                "statusHistory": [
                  {
                    "status": "picked",
                    "createdAt": "2025-04-25T03:20:00"
                  }
                ],
                "subItems": [
                  "<unknown>"
                ]
              }
            ]
          }
        ]
      }
    ],
    "externalId": "rte_JphRWDiEosGpXuxwgaYfY3",
    "name": "Route 1",
    "courierId": "cou_1234567890abcdef12345678",
    "vehicleId": "vhc_1234567890abcdef12345678",
    "courier": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>"
    },
    "driverGroup": {
      "id": "<string>",
      "externalId": "<string>"
    },
    "courierPosition": {
      "lat": 123,
      "lng": 123,
      "updatedAt": "<string>",
      "capturedAt": "<string>",
      "accuracy": 123,
      "heading": 123,
      "speed": 123,
      "altitude": 123,
      "altitudeAccuracy": 123,
      "batteryLevel": 123,
      "batteryIsCharging": true,
      "isMoving": true
    },
    "vehicle": {
      "licensePlate": "<string>",
      "make": "<string>",
      "model": "<string>",
      "color": "<string>",
      "year": 123,
      "type": "<string>"
    },
    "providerName": "<string>",
    "shiftId": "shf_1234567890abcdef12345678",
    "isDispatched": false,
    "jobId": "job_1234567890abcdef12345678",
    "routeMetadata": {
      "priority": "high",
      "source": "optimization_engine"
    },
    "validationErrors": {
      "order_123": "Order 123 has pickup but no dropoff"
    },
    "encodedPolyline": "<string>",
    "status": "CREATED",
    "statusHistory": [
      {
        "created_at": "2025-04-25T03:00:00Z",
        "status": "CREATED"
      },
      {
        "created_at": "2025-04-25T03:10:00Z",
        "status": "ASSIGNED"
      },
      {
        "created_at": "2025-04-25T03:15:00Z",
        "status": "STARTED"
      }
    ]
  }
}
[
  {
    "error": {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    },
    "response_status": "<string>",
    "RequestID": "<string>"
  }
]
This endpoint is deprecated. Please use the Create Order endpoint instead.

​
Scheduled Job Time Calculations

When creating a scheduled job, you must include at least one of the following fields:
  • packagePickupStartTime
  • packagePickupEndTime
  • packageDropoffStartTime
  • packageDropoffEndTime
Times that are not specified will be calculated by Nash. “Now” or ASAP jobs do not require any of these fields. If the specified pickup time of a scheduled job is very close to the current time (within 5 minutes in the past or 10 minutes in the future), it will be automatically transformed into an ASAP job.
For this and all other endpoints, as Nash processes fields from different providers, please assume that any field in the response we provide may be 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. Package Items
Note that it’s still highly recommended to include both pickup and dropoff times since our estimations are based on historical time data rather than real-time metrics.
The fields 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]->packageand selectedConfiguration with jobConfiguration[0]

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Expected payload for creating a job.

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

Detailed description: https://docs.usenash.com/reference/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:
[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]
​
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:
{ "key": "value" }
​
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.

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:
{ "key": "value" }
​
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:
{ "tasks": [] }
​
jobSpecification
Jobspecification · object | null
deprecated

Job specification

Example:
{ "packages": [] }
​
route
RouteSerializer · object | null

Route