Update Job by JobID/ExternalIdentifier
curl --request PATCH \
--url https://api.sandbox.usenash.com/v1/jobs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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
},
"pickupPhoneNumber": "<string>",
"pickupBusinessName": "<string>",
"pickupFirstName": "<string>",
"pickupLastName": "<string>",
"pickupEmail": "<string>",
"pickupInstructions": "<string>",
"pickupStoreLocationId": "<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
},
"dropoffPhoneNumber": "<string>",
"dropoffBusinessName": "<string>",
"dropoffFirstName": "<string>",
"dropoffLastName": "<string>",
"dropoffEmail": "<string>",
"dropoffStoreLocationId": "<string>",
"dropoffInstructions": "<string>",
"dropoffBarcodes": [
"<string>"
],
"packageDeliveryMode": "<string>",
"packagePickupStartTime": "<string>",
"packagePickupEndTime": "<string>",
"packageDropoffStartTime": "<string>",
"packageDropoffEndTime": "<string>",
"packageDescription": "<string>",
"packageRequirements": [
"photo_proof_of_delivery",
"age_verification_on_delivery"
],
"packageMinimumVehicleSize": "car",
"packageValue": 123,
"packageTax": 123,
"tipAmount": 123,
"currency": "<string>",
"packageItems": [
{}
],
"referenceId": "<string>",
"itemsCount": 123,
"weight": 123,
"externalIdentifier": "<string>",
"jobMetadata": {},
"packageMetadata": {}
}
'import requests
url = "https://api.sandbox.usenash.com/v1/jobs/{id}"
payload = {
"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
},
"pickupPhoneNumber": "<string>",
"pickupBusinessName": "<string>",
"pickupFirstName": "<string>",
"pickupLastName": "<string>",
"pickupEmail": "<string>",
"pickupInstructions": "<string>",
"pickupStoreLocationId": "<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
},
"dropoffPhoneNumber": "<string>",
"dropoffBusinessName": "<string>",
"dropoffFirstName": "<string>",
"dropoffLastName": "<string>",
"dropoffEmail": "<string>",
"dropoffStoreLocationId": "<string>",
"dropoffInstructions": "<string>",
"dropoffBarcodes": ["<string>"],
"packageDeliveryMode": "<string>",
"packagePickupStartTime": "<string>",
"packagePickupEndTime": "<string>",
"packageDropoffStartTime": "<string>",
"packageDropoffEndTime": "<string>",
"packageDescription": "<string>",
"packageRequirements": ["photo_proof_of_delivery", "age_verification_on_delivery"],
"packageMinimumVehicleSize": "car",
"packageValue": 123,
"packageTax": 123,
"tipAmount": 123,
"currency": "<string>",
"packageItems": [{}],
"referenceId": "<string>",
"itemsCount": 123,
"weight": 123,
"externalIdentifier": "<string>",
"jobMetadata": {},
"packageMetadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
},
pickupPhoneNumber: '<string>',
pickupBusinessName: '<string>',
pickupFirstName: '<string>',
pickupLastName: '<string>',
pickupEmail: '<string>',
pickupInstructions: '<string>',
pickupStoreLocationId: '<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
},
dropoffPhoneNumber: '<string>',
dropoffBusinessName: '<string>',
dropoffFirstName: '<string>',
dropoffLastName: '<string>',
dropoffEmail: '<string>',
dropoffStoreLocationId: '<string>',
dropoffInstructions: '<string>',
dropoffBarcodes: ['<string>'],
packageDeliveryMode: '<string>',
packagePickupStartTime: '<string>',
packagePickupEndTime: '<string>',
packageDropoffStartTime: '<string>',
packageDropoffEndTime: '<string>',
packageDescription: '<string>',
packageRequirements: ['photo_proof_of_delivery', 'age_verification_on_delivery'],
packageMinimumVehicleSize: 'car',
packageValue: 123,
packageTax: 123,
tipAmount: 123,
currency: '<string>',
packageItems: [{}],
referenceId: '<string>',
itemsCount: 123,
weight: 123,
externalIdentifier: '<string>',
jobMetadata: {},
packageMetadata: {}
})
};
fetch('https://api.sandbox.usenash.com/v1/jobs/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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
],
'pickupPhoneNumber' => '<string>',
'pickupBusinessName' => '<string>',
'pickupFirstName' => '<string>',
'pickupLastName' => '<string>',
'pickupEmail' => '<string>',
'pickupInstructions' => '<string>',
'pickupStoreLocationId' => '<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
],
'dropoffPhoneNumber' => '<string>',
'dropoffBusinessName' => '<string>',
'dropoffFirstName' => '<string>',
'dropoffLastName' => '<string>',
'dropoffEmail' => '<string>',
'dropoffStoreLocationId' => '<string>',
'dropoffInstructions' => '<string>',
'dropoffBarcodes' => [
'<string>'
],
'packageDeliveryMode' => '<string>',
'packagePickupStartTime' => '<string>',
'packagePickupEndTime' => '<string>',
'packageDropoffStartTime' => '<string>',
'packageDropoffEndTime' => '<string>',
'packageDescription' => '<string>',
'packageRequirements' => [
'photo_proof_of_delivery',
'age_verification_on_delivery'
],
'packageMinimumVehicleSize' => 'car',
'packageValue' => 123,
'packageTax' => 123,
'tipAmount' => 123,
'currency' => '<string>',
'packageItems' => [
[
]
],
'referenceId' => '<string>',
'itemsCount' => 123,
'weight' => 123,
'externalIdentifier' => '<string>',
'jobMetadata' => [
],
'packageMetadata' => [
]
]),
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/{id}"
payload := strings.NewReader("{\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 \"pickupPhoneNumber\": \"<string>\",\n \"pickupBusinessName\": \"<string>\",\n \"pickupFirstName\": \"<string>\",\n \"pickupLastName\": \"<string>\",\n \"pickupEmail\": \"<string>\",\n \"pickupInstructions\": \"<string>\",\n \"pickupStoreLocationId\": \"<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 \"dropoffPhoneNumber\": \"<string>\",\n \"dropoffBusinessName\": \"<string>\",\n \"dropoffFirstName\": \"<string>\",\n \"dropoffLastName\": \"<string>\",\n \"dropoffEmail\": \"<string>\",\n \"dropoffStoreLocationId\": \"<string>\",\n \"dropoffInstructions\": \"<string>\",\n \"dropoffBarcodes\": [\n \"<string>\"\n ],\n \"packageDeliveryMode\": \"<string>\",\n \"packagePickupStartTime\": \"<string>\",\n \"packagePickupEndTime\": \"<string>\",\n \"packageDropoffStartTime\": \"<string>\",\n \"packageDropoffEndTime\": \"<string>\",\n \"packageDescription\": \"<string>\",\n \"packageRequirements\": [\n \"photo_proof_of_delivery\",\n \"age_verification_on_delivery\"\n ],\n \"packageMinimumVehicleSize\": \"car\",\n \"packageValue\": 123,\n \"packageTax\": 123,\n \"tipAmount\": 123,\n \"currency\": \"<string>\",\n \"packageItems\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"itemsCount\": 123,\n \"weight\": 123,\n \"externalIdentifier\": \"<string>\",\n \"jobMetadata\": {},\n \"packageMetadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.usenash.com/v1/jobs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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 \"pickupPhoneNumber\": \"<string>\",\n \"pickupBusinessName\": \"<string>\",\n \"pickupFirstName\": \"<string>\",\n \"pickupLastName\": \"<string>\",\n \"pickupEmail\": \"<string>\",\n \"pickupInstructions\": \"<string>\",\n \"pickupStoreLocationId\": \"<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 \"dropoffPhoneNumber\": \"<string>\",\n \"dropoffBusinessName\": \"<string>\",\n \"dropoffFirstName\": \"<string>\",\n \"dropoffLastName\": \"<string>\",\n \"dropoffEmail\": \"<string>\",\n \"dropoffStoreLocationId\": \"<string>\",\n \"dropoffInstructions\": \"<string>\",\n \"dropoffBarcodes\": [\n \"<string>\"\n ],\n \"packageDeliveryMode\": \"<string>\",\n \"packagePickupStartTime\": \"<string>\",\n \"packagePickupEndTime\": \"<string>\",\n \"packageDropoffStartTime\": \"<string>\",\n \"packageDropoffEndTime\": \"<string>\",\n \"packageDescription\": \"<string>\",\n \"packageRequirements\": [\n \"photo_proof_of_delivery\",\n \"age_verification_on_delivery\"\n ],\n \"packageMinimumVehicleSize\": \"car\",\n \"packageValue\": 123,\n \"packageTax\": 123,\n \"tipAmount\": 123,\n \"currency\": \"<string>\",\n \"packageItems\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"itemsCount\": 123,\n \"weight\": 123,\n \"externalIdentifier\": \"<string>\",\n \"jobMetadata\": {},\n \"packageMetadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.usenash.com/v1/jobs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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 \"pickupPhoneNumber\": \"<string>\",\n \"pickupBusinessName\": \"<string>\",\n \"pickupFirstName\": \"<string>\",\n \"pickupLastName\": \"<string>\",\n \"pickupEmail\": \"<string>\",\n \"pickupInstructions\": \"<string>\",\n \"pickupStoreLocationId\": \"<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 \"dropoffPhoneNumber\": \"<string>\",\n \"dropoffBusinessName\": \"<string>\",\n \"dropoffFirstName\": \"<string>\",\n \"dropoffLastName\": \"<string>\",\n \"dropoffEmail\": \"<string>\",\n \"dropoffStoreLocationId\": \"<string>\",\n \"dropoffInstructions\": \"<string>\",\n \"dropoffBarcodes\": [\n \"<string>\"\n ],\n \"packageDeliveryMode\": \"<string>\",\n \"packagePickupStartTime\": \"<string>\",\n \"packagePickupEndTime\": \"<string>\",\n \"packageDropoffStartTime\": \"<string>\",\n \"packageDropoffEndTime\": \"<string>\",\n \"packageDescription\": \"<string>\",\n \"packageRequirements\": [\n \"photo_proof_of_delivery\",\n \"age_verification_on_delivery\"\n ],\n \"packageMinimumVehicleSize\": \"car\",\n \"packageValue\": 123,\n \"packageTax\": 123,\n \"tipAmount\": 123,\n \"currency\": \"<string>\",\n \"packageItems\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"itemsCount\": 123,\n \"weight\": 123,\n \"externalIdentifier\": \"<string>\",\n \"jobMetadata\": {},\n \"packageMetadata\": {}\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": "cor_9dK2mNp7xVt3RfWzY8sLbQ",
"vehicleId": "veh_4hL8pXq2sVn6RtY3wCbD9M",
"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>"
}
]Update Job
Update fields on a Nash job. Updating a job should always work before a quote is selected; once one has been selected, Nash returns an error if the fleet rejects the change.
PATCH
/
v1
/
jobs
/
{id}
Update Job by JobID/ExternalIdentifier
curl --request PATCH \
--url https://api.sandbox.usenash.com/v1/jobs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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
},
"pickupPhoneNumber": "<string>",
"pickupBusinessName": "<string>",
"pickupFirstName": "<string>",
"pickupLastName": "<string>",
"pickupEmail": "<string>",
"pickupInstructions": "<string>",
"pickupStoreLocationId": "<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
},
"dropoffPhoneNumber": "<string>",
"dropoffBusinessName": "<string>",
"dropoffFirstName": "<string>",
"dropoffLastName": "<string>",
"dropoffEmail": "<string>",
"dropoffStoreLocationId": "<string>",
"dropoffInstructions": "<string>",
"dropoffBarcodes": [
"<string>"
],
"packageDeliveryMode": "<string>",
"packagePickupStartTime": "<string>",
"packagePickupEndTime": "<string>",
"packageDropoffStartTime": "<string>",
"packageDropoffEndTime": "<string>",
"packageDescription": "<string>",
"packageRequirements": [
"photo_proof_of_delivery",
"age_verification_on_delivery"
],
"packageMinimumVehicleSize": "car",
"packageValue": 123,
"packageTax": 123,
"tipAmount": 123,
"currency": "<string>",
"packageItems": [
{}
],
"referenceId": "<string>",
"itemsCount": 123,
"weight": 123,
"externalIdentifier": "<string>",
"jobMetadata": {},
"packageMetadata": {}
}
'import requests
url = "https://api.sandbox.usenash.com/v1/jobs/{id}"
payload = {
"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
},
"pickupPhoneNumber": "<string>",
"pickupBusinessName": "<string>",
"pickupFirstName": "<string>",
"pickupLastName": "<string>",
"pickupEmail": "<string>",
"pickupInstructions": "<string>",
"pickupStoreLocationId": "<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
},
"dropoffPhoneNumber": "<string>",
"dropoffBusinessName": "<string>",
"dropoffFirstName": "<string>",
"dropoffLastName": "<string>",
"dropoffEmail": "<string>",
"dropoffStoreLocationId": "<string>",
"dropoffInstructions": "<string>",
"dropoffBarcodes": ["<string>"],
"packageDeliveryMode": "<string>",
"packagePickupStartTime": "<string>",
"packagePickupEndTime": "<string>",
"packageDropoffStartTime": "<string>",
"packageDropoffEndTime": "<string>",
"packageDescription": "<string>",
"packageRequirements": ["photo_proof_of_delivery", "age_verification_on_delivery"],
"packageMinimumVehicleSize": "car",
"packageValue": 123,
"packageTax": 123,
"tipAmount": 123,
"currency": "<string>",
"packageItems": [{}],
"referenceId": "<string>",
"itemsCount": 123,
"weight": 123,
"externalIdentifier": "<string>",
"jobMetadata": {},
"packageMetadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
},
pickupPhoneNumber: '<string>',
pickupBusinessName: '<string>',
pickupFirstName: '<string>',
pickupLastName: '<string>',
pickupEmail: '<string>',
pickupInstructions: '<string>',
pickupStoreLocationId: '<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
},
dropoffPhoneNumber: '<string>',
dropoffBusinessName: '<string>',
dropoffFirstName: '<string>',
dropoffLastName: '<string>',
dropoffEmail: '<string>',
dropoffStoreLocationId: '<string>',
dropoffInstructions: '<string>',
dropoffBarcodes: ['<string>'],
packageDeliveryMode: '<string>',
packagePickupStartTime: '<string>',
packagePickupEndTime: '<string>',
packageDropoffStartTime: '<string>',
packageDropoffEndTime: '<string>',
packageDescription: '<string>',
packageRequirements: ['photo_proof_of_delivery', 'age_verification_on_delivery'],
packageMinimumVehicleSize: 'car',
packageValue: 123,
packageTax: 123,
tipAmount: 123,
currency: '<string>',
packageItems: [{}],
referenceId: '<string>',
itemsCount: 123,
weight: 123,
externalIdentifier: '<string>',
jobMetadata: {},
packageMetadata: {}
})
};
fetch('https://api.sandbox.usenash.com/v1/jobs/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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
],
'pickupPhoneNumber' => '<string>',
'pickupBusinessName' => '<string>',
'pickupFirstName' => '<string>',
'pickupLastName' => '<string>',
'pickupEmail' => '<string>',
'pickupInstructions' => '<string>',
'pickupStoreLocationId' => '<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
],
'dropoffPhoneNumber' => '<string>',
'dropoffBusinessName' => '<string>',
'dropoffFirstName' => '<string>',
'dropoffLastName' => '<string>',
'dropoffEmail' => '<string>',
'dropoffStoreLocationId' => '<string>',
'dropoffInstructions' => '<string>',
'dropoffBarcodes' => [
'<string>'
],
'packageDeliveryMode' => '<string>',
'packagePickupStartTime' => '<string>',
'packagePickupEndTime' => '<string>',
'packageDropoffStartTime' => '<string>',
'packageDropoffEndTime' => '<string>',
'packageDescription' => '<string>',
'packageRequirements' => [
'photo_proof_of_delivery',
'age_verification_on_delivery'
],
'packageMinimumVehicleSize' => 'car',
'packageValue' => 123,
'packageTax' => 123,
'tipAmount' => 123,
'currency' => '<string>',
'packageItems' => [
[
]
],
'referenceId' => '<string>',
'itemsCount' => 123,
'weight' => 123,
'externalIdentifier' => '<string>',
'jobMetadata' => [
],
'packageMetadata' => [
]
]),
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/{id}"
payload := strings.NewReader("{\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 \"pickupPhoneNumber\": \"<string>\",\n \"pickupBusinessName\": \"<string>\",\n \"pickupFirstName\": \"<string>\",\n \"pickupLastName\": \"<string>\",\n \"pickupEmail\": \"<string>\",\n \"pickupInstructions\": \"<string>\",\n \"pickupStoreLocationId\": \"<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 \"dropoffPhoneNumber\": \"<string>\",\n \"dropoffBusinessName\": \"<string>\",\n \"dropoffFirstName\": \"<string>\",\n \"dropoffLastName\": \"<string>\",\n \"dropoffEmail\": \"<string>\",\n \"dropoffStoreLocationId\": \"<string>\",\n \"dropoffInstructions\": \"<string>\",\n \"dropoffBarcodes\": [\n \"<string>\"\n ],\n \"packageDeliveryMode\": \"<string>\",\n \"packagePickupStartTime\": \"<string>\",\n \"packagePickupEndTime\": \"<string>\",\n \"packageDropoffStartTime\": \"<string>\",\n \"packageDropoffEndTime\": \"<string>\",\n \"packageDescription\": \"<string>\",\n \"packageRequirements\": [\n \"photo_proof_of_delivery\",\n \"age_verification_on_delivery\"\n ],\n \"packageMinimumVehicleSize\": \"car\",\n \"packageValue\": 123,\n \"packageTax\": 123,\n \"tipAmount\": 123,\n \"currency\": \"<string>\",\n \"packageItems\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"itemsCount\": 123,\n \"weight\": 123,\n \"externalIdentifier\": \"<string>\",\n \"jobMetadata\": {},\n \"packageMetadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.usenash.com/v1/jobs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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 \"pickupPhoneNumber\": \"<string>\",\n \"pickupBusinessName\": \"<string>\",\n \"pickupFirstName\": \"<string>\",\n \"pickupLastName\": \"<string>\",\n \"pickupEmail\": \"<string>\",\n \"pickupInstructions\": \"<string>\",\n \"pickupStoreLocationId\": \"<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 \"dropoffPhoneNumber\": \"<string>\",\n \"dropoffBusinessName\": \"<string>\",\n \"dropoffFirstName\": \"<string>\",\n \"dropoffLastName\": \"<string>\",\n \"dropoffEmail\": \"<string>\",\n \"dropoffStoreLocationId\": \"<string>\",\n \"dropoffInstructions\": \"<string>\",\n \"dropoffBarcodes\": [\n \"<string>\"\n ],\n \"packageDeliveryMode\": \"<string>\",\n \"packagePickupStartTime\": \"<string>\",\n \"packagePickupEndTime\": \"<string>\",\n \"packageDropoffStartTime\": \"<string>\",\n \"packageDropoffEndTime\": \"<string>\",\n \"packageDescription\": \"<string>\",\n \"packageRequirements\": [\n \"photo_proof_of_delivery\",\n \"age_verification_on_delivery\"\n ],\n \"packageMinimumVehicleSize\": \"car\",\n \"packageValue\": 123,\n \"packageTax\": 123,\n \"tipAmount\": 123,\n \"currency\": \"<string>\",\n \"packageItems\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"itemsCount\": 123,\n \"weight\": 123,\n \"externalIdentifier\": \"<string>\",\n \"jobMetadata\": {},\n \"packageMetadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.usenash.com/v1/jobs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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 \"pickupPhoneNumber\": \"<string>\",\n \"pickupBusinessName\": \"<string>\",\n \"pickupFirstName\": \"<string>\",\n \"pickupLastName\": \"<string>\",\n \"pickupEmail\": \"<string>\",\n \"pickupInstructions\": \"<string>\",\n \"pickupStoreLocationId\": \"<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 \"dropoffPhoneNumber\": \"<string>\",\n \"dropoffBusinessName\": \"<string>\",\n \"dropoffFirstName\": \"<string>\",\n \"dropoffLastName\": \"<string>\",\n \"dropoffEmail\": \"<string>\",\n \"dropoffStoreLocationId\": \"<string>\",\n \"dropoffInstructions\": \"<string>\",\n \"dropoffBarcodes\": [\n \"<string>\"\n ],\n \"packageDeliveryMode\": \"<string>\",\n \"packagePickupStartTime\": \"<string>\",\n \"packagePickupEndTime\": \"<string>\",\n \"packageDropoffStartTime\": \"<string>\",\n \"packageDropoffEndTime\": \"<string>\",\n \"packageDescription\": \"<string>\",\n \"packageRequirements\": [\n \"photo_proof_of_delivery\",\n \"age_verification_on_delivery\"\n ],\n \"packageMinimumVehicleSize\": \"car\",\n \"packageValue\": 123,\n \"packageTax\": 123,\n \"tipAmount\": 123,\n \"currency\": \"<string>\",\n \"packageItems\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"itemsCount\": 123,\n \"weight\": 123,\n \"externalIdentifier\": \"<string>\",\n \"jobMetadata\": {},\n \"packageMetadata\": {}\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": "cor_9dK2mNp7xVt3RfWzY8sLbQ",
"vehicleId": "veh_4hL8pXq2sVn6RtY3wCbD9M",
"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>"
}
]Pre-dispatch updates
Updating a job should always work before a quote is selected. Some updates may result in pricing changes. You can only update the package delivery times and the pickup or dropoff addresses before an order has been dispatched to a fleet. If any task in a job is dispatched and you attempt to update a delivery time or address, the endpoint returns an error. If you update any of the following fields, the quotes returned by the job are refreshed and the endpoint returns a new set of quotes. Any existing quotes (and quote IDs) become invalid for dispatch. The fields that force a quote refresh:pickupAddressdropoffAddresspackagePickupStartTimepackagePickupEndTimepackageDropoffStartTimepackageDropoffEndTimepackageDeliveryModepackageRequirementspackageMinimumVehicleSizepackageValue: this field can also be updated in the post-dispatch stage
Updating times
To update the times of a job, provide at least one ofpackagePickupStartTime, packagePickupEndTime, packageDropoffStartTime, and packageDropoffEndTime. Times you don’t specify are calculated by Nash, and any previous times left out of the update request are overwritten. So to change one time field and keep the rest, send the others in the same request.
If you change
packageDeliveryMode from SCHEDULED to NOW, you don’t need to specify any other time fields.Post-dispatch updates
If a quote has been selected or the job was dispatched by auto-dispatch, Nash returns an error if any of the assigned fleets in the job reject the update. In the post-dispatch stage, updating the package value of the job may result in a price change, depending on how the providers calculate their pricing. Below is a list of fields that can be updated, with more detail on pre-dispatch and post-dispatch restrictions.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Job ID or External Identifier
Job Configuration ID (for updating a package in a batch job)
Body
application/json
Expected input for update job endpoint.
Pickup address
Parsed address input serializer for creating a job.
Show child attributes
Show child attributes
Pickup phone number
Pickup business name
Pickup first name
Pickup last name
Pickup email
Pickup instructions
Pickup store location ID
Dropoff address
Parsed address input serializer for creating a job.
Show child attributes
Show child attributes
Dropoff phone number
Dropoff business name
Dropoff first name
Dropoff last name
Dropoff email
Dropoff store location ID
Dropoff instructions
Package delivery mode
Package pickup start time
Pattern:
(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?Package pickup end time
Pattern:
(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?Package dropoff start time
Pattern:
(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?Package dropoff end time
Pattern:
(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?Package description
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"
]
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"
Package value
Package tax
Tip amount
Currency
List of items in the package
Reference ID
Items count
Package weight
External identifier for the job
Job metadata
Package metadata
Response
OK
A Nash Job.
Job ID
Example:
"job_01234567890"
Created at
Example:
"2023-08-29T19:17:46.264523"
Portal URL
Example:
"https://usenash.com/portal/job_abc123"
Is the job active
Example:
true
Is the job a batch
Example:
false
Job configurations
Show child attributes
Show child attributes
External identifier
Example:
"mini-mart-order-99"
Job metadata
Example:
{ "key": "value" }
Options group
Show child attributes
Show child attributes
7-digit non-unique human-readable reference code for the job.
Example:
"0123456"
Selected configuration
Show child attributes
Show child attributes
Example:
{ "tasks": [] }
Job specification
Show child attributes
Show child attributes
Example:
{ "packages": [] }
Route
Show child attributes
Show child attributes
Was this page helpful?
⌘I