Select Quote (Batch)

POST

select_quote

curl --request POST \
  --url https://api.sandbox.usenash.com/v1/select_quote \
  --header 'Content-Type: application/json' \
  --data '{
  "quoteId": "qot_01234567890"
}'

{
  "job": {
    "id": "job_01234567890",
    "createdAt": "2023-08-29T19:17:46.264523",
    "portalUrl": "https://usenash.com/portal/job_abc123",
    "externalIdentifier": "mini-mart-order-99",
    "jobMetadata": {
      "key": "value"
    },
    "isActive": true,
    "isBatch": false,
    "jobConfigurations": [
      {
        "id": "cfg_01234567890",
        "package": {
          "id": "pkg_01234567890",
          "description": "Package description",
          "requirements": [
            "photo_proof_of_delivery",
            "age_verification_on_delivery"
          ],
          "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>"
          ],
          "valueCents": 123,
          "taxCents": 100,
          "serviceFeeCents": 100,
          "itemsCount": 100,
          "externalIdentifier": "mini-mart-order-99",
          "minimumVehicleSize": "car",
          "pickupLocation": {
            "id": "loc_01234567890",
            "address": "1600 Amphitheatre Parkway",
            "formattedAddress": "1600 Amphitheatre Parkway",
            "addressNumber": "1600",
            "addressFormattedStreet": "Amphitheatre Parkway",
            "addressCity": "Mountain View",
            "addressCounty": "Santa Clara",
            "addressState": "CA",
            "addressZip": "94043",
            "addressCountry": "US",
            "timezoneId": "America/Los_Angeles",
            "timezoneName": "Pacific Time",
            "instructions": "Turn left on Main St",
            "businessName": "Nash",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "+15555555555",
            "email": "john.doe@example.com"
          },
          "pickupStoreLocationId": "store_01234567890",
          "dropoffLocation": {
            "id": "loc_01234567890",
            "address": "1600 Amphitheatre Parkway",
            "formattedAddress": "1600 Amphitheatre Parkway",
            "addressNumber": "1600",
            "addressFormattedStreet": "Amphitheatre Parkway",
            "addressCity": "Mountain View",
            "addressCounty": "Santa Clara",
            "addressState": "CA",
            "addressZip": "94043",
            "addressCountry": "US",
            "timezoneId": "America/Los_Angeles",
            "timezoneName": "Pacific Time",
            "instructions": "Turn left on Main St",
            "businessName": "Nash",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "+15555555555",
            "email": "john.doe@example.com"
          },
          "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",
              "type": "<string>",
              "status": "dropoff_complete",
              "statusHistory": [
                {
                  "created_at": "2023-08-29T19:17:46.264523",
                  "status": "created"
                },
                {
                  "created_at": "2023-08-29T19:17:47.509265",
                  "status": "not_assigned_driver"
                }
              ],
              "isActive": true,
              "pickupEta": "<string>",
              "dropoffEta": "<string>",
              "dropoffDeadline": "<string>",
              "priceCents": 123,
              "currency": "<string>",
              "documents": [
                {
                  "createdAt": "<string>",
                  "id": "<string>",
                  "type": "<string>",
                  "url": "<string>",
                  "contentType": "<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
            },
            "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",
            "type": "<string>",
            "status": "dropoff_complete",
            "statusHistory": [
              {
                "created_at": "2023-08-29T19:17:46.264523",
                "status": "created"
              },
              {
                "created_at": "2023-08-29T19:17:47.509265",
                "status": "not_assigned_driver"
              }
            ],
            "isActive": true,
            "pickupEta": "<string>",
            "dropoffEta": "<string>",
            "dropoffDeadline": "<string>",
            "priceCents": 123,
            "currency": "<string>",
            "documents": [
              {
                "createdAt": "<string>",
                "id": "<string>",
                "type": "<string>",
                "url": "<string>",
                "contentType": "<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
          },
          "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",
          "type": "<string>",
          "status": "dropoff_complete",
          "statusHistory": [
            {
              "created_at": "2023-08-29T19:17:46.264523",
              "status": "created"
            },
            {
              "created_at": "2023-08-29T19:17:47.509265",
              "status": "not_assigned_driver"
            }
          ],
          "isActive": true,
          "pickupEta": "<string>",
          "dropoffEta": "<string>",
          "dropoffDeadline": "<string>",
          "priceCents": 123,
          "currency": "<string>",
          "documents": [
            {
              "createdAt": "<string>",
              "id": "<string>",
              "type": "<string>",
              "url": "<string>",
              "contentType": "<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
        },
        "publicTrackingUrl": "https://usenash.com/tracking/job_abc123"
      }
    ],
    "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": []
    }
  }
}

Body

application/json

Expected input for selecting a quote.

quoteId

string

required

Unique reference number for the quote that should be selected to create a job and start a delivery

Example:

"qot_01234567890"

Response

200

application/json

Expected output when selecting a quote for a task, batch , order.

job

object

required

A Nash Job.

job.id

string

required

Job ID

Example:

"job_01234567890"

job.createdAt

string

required

Created at

Example:

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

job.portalUrl

string

required

Portal URL

Example:

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

job.isActive

boolean

required

Is the job active

Example:

true

job.isBatch

boolean

required

Is the job a batch

Example:

false

job.jobConfigurations

object[]

required

Job configurations

Generic serializer for jbo configurations used in many endpoints.

job.jobConfigurations.id

string

required

Job Configuration ID

Example:

"cfg_01234567890"

job.jobConfigurations.package

object

required

Package

job.jobConfigurations.package.id

string

required

Package ID

Example:

"pkg_01234567890"

job.jobConfigurations.package.requirements

string[]

required

Requirements

Example:

[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]

job.jobConfigurations.package.valueCents

integer

required

job.jobConfigurations.package.itemsCount

required

Items count

Example:

100

job.jobConfigurations.package.pickupLocation

object

required

Generic serializer for location used in many endpoints.

job.jobConfigurations.package.dropoffLocation

object

required

Generic serializer for location used in many endpoints.

job.jobConfigurations.package.description

string | null

Description

Example:

"Package description"

job.jobConfigurations.package.tags

string[] | null

Tags

Example:

["Alcohol"]

job.jobConfigurations.package.packageDeliveryMode

string | null

Package delivery mode

Example:

"now"

job.jobConfigurations.package.pickupStartTime

string | null

Pickup start time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.package.pickupEndTime

string | null

Pickup end time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.package.pickupBarcodes

string[] | null

job.jobConfigurations.package.dropoffStartTime

string | null

Dropoff start time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.package.dropoffEndTime

string | null

Dropoff end time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.package.dropoffBarcodes

string[] | null

job.jobConfigurations.package.taxCents

integer | null

Tax in cents

Example:

100

job.jobConfigurations.package.serviceFeeCents

integer | null

Service fee in cents

Example:

100

job.jobConfigurations.package.externalIdentifier

string | null

External identifier

Example:

"mini-mart-order-99"

job.jobConfigurations.package.minimumVehicleSize

string | null

Minimum vehicle size

Example:

"car"

job.jobConfigurations.package.pickupStoreLocationId

string | null

Pickup store location ID

Example:

"store_01234567890"

job.jobConfigurations.package.dropoffStoreLocationId

string | null

Dropoff store location ID

Example:

"store_01234567890"

job.jobConfigurations.package.drivingMetrics

object | null

Driving metrics (distance in meters, duration in seconds)

Example:

{ "distance": 100, "duration": 100 }

job.jobConfigurations.package.value

number | null

Value

Example:

100

job.jobConfigurations.package.tax

Tax

Example:

100

job.jobConfigurations.package.serviceFee

Service fee

Example:

100

job.jobConfigurations.package.tipAmountCents

integer | null

job.jobConfigurations.package.weight

Weight

Example:

100

job.jobConfigurations.package.dimensions

object | null

Dimensions

Example:

{
  "height": 100,
  "length": 100,
  "width": 100
}

job.jobConfigurations.package.items

object[] | null

Items

Example:

[
  {
    "count": 1,
    "description": "Item 1",
    "valueCents": 100
  }
]

job.jobConfigurations.package.referenceId

string | null

Reference ID

Example:

"mini-mart-order-99"

job.jobConfigurations.package.packageMetadata

object | null

Package metadata

Example:

{ "key": "value" }

job.jobConfigurations.tasks

object[]

required

Tasks

Generic serializer for tasks used in many endpoints.

job.jobConfigurations.tasks.id

string

required

Task ID

Example:

"tsk_01234567890"

job.jobConfigurations.tasks.createdAt

string

required

Created at

Example:

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

job.jobConfigurations.tasks.status

string

required

Status

Example:

"running"

job.jobConfigurations.tasks.pickupStartTime

string | null

Pickup start time

Example:

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

job.jobConfigurations.tasks.pickupEndTime

string | null

Pickup end time

Example:

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

job.jobConfigurations.tasks.dropoffStartTime

string | null

Dropoff start time

Example:

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

job.jobConfigurations.tasks.dropoffEndTime

string | null

Dropoff end time

Example:

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

job.jobConfigurations.tasks.providerId

string | null

Provider ID

Example:

"prv_01234567890"

job.jobConfigurations.tasks.providerIsInternal

boolean | null

Provider is internal

Example:

true

job.jobConfigurations.tasks.tipAmountCents

integer | null

Tip amount in cents

Example:

100

job.jobConfigurations.tasks.winnerQuote

object | null

Winner quote

Example:

{
  "id": "qot_01234567890",
  "price_cents": 100
}

job.jobConfigurations.tasks.quotes

object[] | null

Quotes

Generic serializer for quotes used in many endpoints.

job.jobConfigurations.tasks.quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

job.jobConfigurations.tasks.quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

job.jobConfigurations.tasks.quotes.providerName

string

required

Provider name

Example:

"Nash"

job.jobConfigurations.tasks.quotes.createdTime

string

required

Created time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.tasks.quotes.priceCents

integer

required

Price in cents

Example:

1000

job.jobConfigurations.tasks.quotes.type

string | null

Quote type

job.jobConfigurations.tasks.quotes.providerLogo

string | null

Provider logo

Example:

"https://nash.com/logo.png"

job.jobConfigurations.tasks.quotes.providerIsInternal

boolean | null

Is the provider internal

job.jobConfigurations.tasks.quotes.expireTime

string | null

Expire time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.tasks.quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

job.jobConfigurations.tasks.quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

job.jobConfigurations.tasks.quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

job.jobConfigurations.tasks.quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

job.jobConfigurations.tasks.quotes.currency

string | null

Currency

Example:

"USD"

job.jobConfigurations.tasks.quotes.pickupWindow

string | null

Pickup window

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.tasks.quotes.dropoffEta

string | null

Dropoff ETA

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.tasks.quotes.tags

string[] | null

Tags

Example:

["tag1", "tag2"]

job.jobConfigurations.tasks.quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

job.jobConfigurations.tasks.quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

job.jobConfigurations.tasks.quotes.totalPriceBreakdown

object | null

Total price breakdown

Example:

{
  "subtotal": 1000,
  "tax": 100,
  "total": 1100
}

job.jobConfigurations.tasks.quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

job.jobConfigurations.tasks.quotes.price

number | null

Price

Example:

1000

job.jobConfigurations.tasks.quotes.isSuccessful

boolean | null

Is successful

Example:

true

job.jobConfigurations.tasks.quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

[
  {
    "id": "qot_01234567890",
    "price_cents": 100
  }
]

job.jobConfigurations.tasks.failedQuotes

object[] | null

Failed quotes

Example:

[
  {
    "id": "qot_01234567890",
    "price_cents": 100
  }
]

job.jobConfigurations.tasks.delivery

object | null

Delivery object

job.jobConfigurations.tasks.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

job.jobConfigurations.tasks.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

job.jobConfigurations.tasks.delivery.isActive

boolean

required

Is the delivery active

job.jobConfigurations.tasks.delivery.priceCents

integer

required

Price in cents

job.jobConfigurations.tasks.delivery.currency

string

required

Currency

job.jobConfigurations.tasks.delivery.type

string | null

job.jobConfigurations.tasks.delivery.statusHistory

object[] | null

Delivery status history

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "status": "created"
  },
  {
    "created_at": "2023-08-29T19:17:47.509265",
    "status": "not_assigned_driver"
  }
]

job.jobConfigurations.tasks.delivery.pickupEta

string | null

Pickup ETA

job.jobConfigurations.tasks.delivery.dropoffEta

string | null

Dropoff ETA

job.jobConfigurations.tasks.delivery.dropoffDeadline

string | null

Dropoff deadline

job.jobConfigurations.tasks.delivery.documents

object[] | null

Documents

Generic serializer for Nash documents; Used for output.

job.jobConfigurations.tasks.delivery.nashFeeCents

integer | null

Nash fee in cents

job.jobConfigurations.tasks.delivery.courierName

string | null

Courier name

job.jobConfigurations.tasks.delivery.courierPhoneNumber

string | null

Courier phone number

job.jobConfigurations.tasks.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

job.jobConfigurations.tasks.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

job.jobConfigurations.tasks.delivery.courierLocation

object | null

Courier location

job.jobConfigurations.tasks.delivery.courierVehicle

object | null

Courier vehicle

job.jobConfigurations.tasks.delivery.courierProfileImage

string | null

Courier profile image

job.jobConfigurations.tasks.delivery.proofOfDelivery

object[] | null

Proof of delivery

job.jobConfigurations.tasks.delivery.providerDeliveryId

string | null

Provider delivery id

job.jobConfigurations.tasks.delivery.providerBatchId

string | null

Provider batch id

job.jobConfigurations.tasks.delivery.price

number | null

Price

job.jobConfigurations.tasks.delivery.taxAmountCents

integer | null

Tax amount in cents

job.jobConfigurations.tasks.delivery.tollFeeCents

integer | null

Toll fee in cents

job.jobConfigurations.tasks.delivery.waitFeeCents

integer | null

Wait fee in cents

job.jobConfigurations.tasks.delivery.waitTimeMinutes

integer | null

Wait time in minutes

job.jobConfigurations.tasks.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

job.jobConfigurations.tasks.delivery.returnFeeCents

integer | null

Return fee in cents

job.jobConfigurations.tasks.delivery.otherProviderFees

object | null

Other provider fees

job.jobConfigurations.tasks.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

job.jobConfigurations.tasks.delivery.totalPriceBreakdown

object | null

Total price breakdown

job.jobConfigurations.tasks.delivery.totalPriceCents

integer | null

Total price in cents

job.jobConfigurations.tasks.tipAmountUsd

number | null

Tip amount in USD

Example:

100

job.jobConfigurations.tasks.failureReason

string | null

Failure reason

Example:

"Task failed"

job.jobConfigurations.tasks.taskNotes

object[] | null

Task notes

Generic serializer for notes used in many endpoints.

job.jobConfigurations.tasks.taskNotes.id

string

required

Note ID

Example:

"not_01234567890"

job.jobConfigurations.tasks.taskNotes.createdAt

string

required

Created at

Example:

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

job.jobConfigurations.tasks.taskNotes.note

string

required

Note

Example:

"Task note"

job.jobConfigurations.tasks.taskNotes.user

object | null

required

User

Example:

{ "email": "john.doe@example.com" }

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "id": "not_01234567890",
    "note": "Task note",
    "user": { "email": "john.doe@example.com" }
  }
]

job.jobConfigurations.advancedTask

object | null

Advanced task

job.jobConfigurations.advancedTask.id

string

required

Task ID

Example:

"tsk_01234567890"

job.jobConfigurations.advancedTask.createdAt

string

required

Created at

Example:

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

job.jobConfigurations.advancedTask.status

string

required

Status

Example:

"running"

job.jobConfigurations.advancedTask.pickupStartTime

string | null

Pickup start time

Example:

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

job.jobConfigurations.advancedTask.pickupEndTime

string | null

Pickup end time

Example:

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

job.jobConfigurations.advancedTask.dropoffStartTime

string | null

Dropoff start time

Example:

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

job.jobConfigurations.advancedTask.dropoffEndTime

string | null

Dropoff end time

Example:

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

job.jobConfigurations.advancedTask.providerId

string | null

Provider ID

Example:

"prv_01234567890"

job.jobConfigurations.advancedTask.providerIsInternal

boolean | null

Provider is internal

Example:

true

job.jobConfigurations.advancedTask.tipAmountCents

integer | null

Tip amount in cents

Example:

100

job.jobConfigurations.advancedTask.winnerQuote

object | null

Winner quote

Example:

{
  "id": "qot_01234567890",
  "price_cents": 100
}

job.jobConfigurations.advancedTask.quotes

object[] | null

Quotes

Generic serializer for quotes used in many endpoints.

job.jobConfigurations.advancedTask.quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

job.jobConfigurations.advancedTask.quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

job.jobConfigurations.advancedTask.quotes.providerName

string

required

Provider name

Example:

"Nash"

job.jobConfigurations.advancedTask.quotes.createdTime

string

required

Created time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.advancedTask.quotes.priceCents

integer

required

Price in cents

Example:

1000

job.jobConfigurations.advancedTask.quotes.type

string | null

Quote type

job.jobConfigurations.advancedTask.quotes.providerLogo

string | null

Provider logo

Example:

"https://nash.com/logo.png"

job.jobConfigurations.advancedTask.quotes.providerIsInternal

boolean | null

Is the provider internal

job.jobConfigurations.advancedTask.quotes.expireTime

string | null

Expire time

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.advancedTask.quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

job.jobConfigurations.advancedTask.quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

job.jobConfigurations.advancedTask.quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

job.jobConfigurations.advancedTask.quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

job.jobConfigurations.advancedTask.quotes.currency

string | null

Currency

Example:

"USD"

job.jobConfigurations.advancedTask.quotes.pickupWindow

string | null

Pickup window

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.advancedTask.quotes.dropoffEta

string | null

Dropoff ETA

Example:

"2021-01-01T00:00:00Z"

job.jobConfigurations.advancedTask.quotes.tags

string[] | null

Tags

Example:

["tag1", "tag2"]

job.jobConfigurations.advancedTask.quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

job.jobConfigurations.advancedTask.quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

job.jobConfigurations.advancedTask.quotes.totalPriceBreakdown

object | null

Total price breakdown

Example:

{
  "subtotal": 1000,
  "tax": 100,
  "total": 1100
}

job.jobConfigurations.advancedTask.quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

job.jobConfigurations.advancedTask.quotes.price

number | null

Price

Example:

1000

job.jobConfigurations.advancedTask.quotes.isSuccessful

boolean | null

Is successful

Example:

true

job.jobConfigurations.advancedTask.quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

[
  {
    "id": "qot_01234567890",
    "price_cents": 100
  }
]

job.jobConfigurations.advancedTask.failedQuotes

object[] | null

Failed quotes

Example:

[
  {
    "id": "qot_01234567890",
    "price_cents": 100
  }
]

job.jobConfigurations.advancedTask.delivery

object | null

Delivery object

job.jobConfigurations.advancedTask.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

job.jobConfigurations.advancedTask.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

job.jobConfigurations.advancedTask.delivery.isActive

boolean

required

Is the delivery active

job.jobConfigurations.advancedTask.delivery.priceCents

integer

required

Price in cents

job.jobConfigurations.advancedTask.delivery.currency

string

required

Currency

job.jobConfigurations.advancedTask.delivery.type

string | null

job.jobConfigurations.advancedTask.delivery.statusHistory

object[] | null

Delivery status history

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "status": "created"
  },
  {
    "created_at": "2023-08-29T19:17:47.509265",
    "status": "not_assigned_driver"
  }
]

job.jobConfigurations.advancedTask.delivery.pickupEta

string | null

Pickup ETA

job.jobConfigurations.advancedTask.delivery.dropoffEta

string | null

Dropoff ETA

job.jobConfigurations.advancedTask.delivery.dropoffDeadline

string | null

Dropoff deadline

job.jobConfigurations.advancedTask.delivery.documents

object[] | null

Documents

Generic serializer for Nash documents; Used for output.

job.jobConfigurations.advancedTask.delivery.nashFeeCents

integer | null

Nash fee in cents

job.jobConfigurations.advancedTask.delivery.courierName

string | null

Courier name

job.jobConfigurations.advancedTask.delivery.courierPhoneNumber

string | null

Courier phone number

job.jobConfigurations.advancedTask.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

job.jobConfigurations.advancedTask.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

job.jobConfigurations.advancedTask.delivery.courierLocation

object | null

Courier location

job.jobConfigurations.advancedTask.delivery.courierVehicle

object | null

Courier vehicle

job.jobConfigurations.advancedTask.delivery.courierProfileImage

string | null

Courier profile image

job.jobConfigurations.advancedTask.delivery.proofOfDelivery

object[] | null

Proof of delivery

job.jobConfigurations.advancedTask.delivery.providerDeliveryId

string | null

Provider delivery id

job.jobConfigurations.advancedTask.delivery.providerBatchId

string | null

Provider batch id

job.jobConfigurations.advancedTask.delivery.price

number | null

Price

job.jobConfigurations.advancedTask.delivery.taxAmountCents

integer | null

Tax amount in cents

job.jobConfigurations.advancedTask.delivery.tollFeeCents

integer | null

Toll fee in cents

job.jobConfigurations.advancedTask.delivery.waitFeeCents

integer | null

Wait fee in cents

job.jobConfigurations.advancedTask.delivery.waitTimeMinutes

integer | null

Wait time in minutes

job.jobConfigurations.advancedTask.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

job.jobConfigurations.advancedTask.delivery.returnFeeCents

integer | null

Return fee in cents

job.jobConfigurations.advancedTask.delivery.otherProviderFees

object | null

Other provider fees

job.jobConfigurations.advancedTask.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

job.jobConfigurations.advancedTask.delivery.totalPriceBreakdown

object | null

Total price breakdown

job.jobConfigurations.advancedTask.delivery.totalPriceCents

integer | null

Total price in cents

job.jobConfigurations.advancedTask.tipAmountUsd

number | null

Tip amount in USD

Example:

100

job.jobConfigurations.advancedTask.failureReason

string | null

Failure reason

Example:

"Task failed"

job.jobConfigurations.advancedTask.taskNotes

object[] | null

Task notes

Generic serializer for notes used in many endpoints.

job.jobConfigurations.advancedTask.taskNotes.id

string

required

Note ID

Example:

"not_01234567890"

job.jobConfigurations.advancedTask.taskNotes.createdAt

string

required

Created at

Example:

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

job.jobConfigurations.advancedTask.taskNotes.note

string

required

Note

Example:

"Task note"

job.jobConfigurations.advancedTask.taskNotes.user

object | null

required

User

Example:

{ "email": "john.doe@example.com" }

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "id": "not_01234567890",
    "note": "Task note",
    "user": { "email": "john.doe@example.com" }
  }
]

job.jobConfigurations.delivery

object | null

Delivery

job.jobConfigurations.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

job.jobConfigurations.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

job.jobConfigurations.delivery.isActive

boolean

required

Is the delivery active

job.jobConfigurations.delivery.priceCents

integer

required

Price in cents

job.jobConfigurations.delivery.currency

string

required

Currency

job.jobConfigurations.delivery.type

string | null

job.jobConfigurations.delivery.statusHistory

object[] | null

Delivery status history

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "status": "created"
  },
  {
    "created_at": "2023-08-29T19:17:47.509265",
    "status": "not_assigned_driver"
  }
]

job.jobConfigurations.delivery.pickupEta

string | null

Pickup ETA

job.jobConfigurations.delivery.dropoffEta

string | null

Dropoff ETA

job.jobConfigurations.delivery.dropoffDeadline

string | null

Dropoff deadline

job.jobConfigurations.delivery.documents

object[] | null

Documents

Generic serializer for Nash documents; Used for output.

job.jobConfigurations.delivery.nashFeeCents

integer | null

Nash fee in cents

job.jobConfigurations.delivery.courierName

string | null

Courier name

job.jobConfigurations.delivery.courierPhoneNumber

string | null

Courier phone number

job.jobConfigurations.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

job.jobConfigurations.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

job.jobConfigurations.delivery.courierLocation

object | null

Courier location

job.jobConfigurations.delivery.courierVehicle

object | null

Courier vehicle

job.jobConfigurations.delivery.courierProfileImage

string | null

Courier profile image

job.jobConfigurations.delivery.proofOfDelivery

object[] | null

Proof of delivery

job.jobConfigurations.delivery.providerDeliveryId

string | null

Provider delivery id

job.jobConfigurations.delivery.providerBatchId

string | null

Provider batch id

job.jobConfigurations.delivery.price

number | null

Price

job.jobConfigurations.delivery.taxAmountCents

integer | null

Tax amount in cents

job.jobConfigurations.delivery.tollFeeCents

integer | null

Toll fee in cents

job.jobConfigurations.delivery.waitFeeCents

integer | null

Wait fee in cents

job.jobConfigurations.delivery.waitTimeMinutes

integer | null

Wait time in minutes

job.jobConfigurations.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

job.jobConfigurations.delivery.returnFeeCents

integer | null

Return fee in cents

job.jobConfigurations.delivery.otherProviderFees

object | null

Other provider fees

job.jobConfigurations.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

job.jobConfigurations.delivery.totalPriceBreakdown

object | null

Total price breakdown

job.jobConfigurations.delivery.totalPriceCents

integer | null

Total price in cents

job.jobConfigurations.publicTrackingUrl

string | null

Public tracking URL

Example:

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

job.externalIdentifier

string | null

External identifier

Example:

"mini-mart-order-99"

job.jobMetadata

object | null

Job metadata

Example:

{ "key": "value" }

job.optionsGroup

object | null

Options group

job.optionsGroup.id

string

required

Dispatch Strategy ID

Example:

"opn_WyMhHj"

job.optionsGroup.label

string

required

Dispatch Strategy Label

Example:

"New York City Strategy"

job.optionsGroup.allowedProviders

string[] | null

Allowed providers

Example:

["prv_01234567890", "prv_01234567891"]

job.optionsGroup.enableAutoDispatch

boolean | null

Enable auto dispatch

Example:

true

job.optionsGroup.providerSelectionStrategy

string | null

Provider selection strategy

Example:

"cheapest"

job.optionsGroup.reassignOnFailure

boolean | null

Reassign on failure

Example:

true

job.optionsGroup.enableMaxDeliveryFee

boolean | null

Enable max delivery fee

Example:

true

job.optionsGroup.maxDeliveryFeeCents

integer | null

Max delivery fee in cents

Example:

10000

job.optionsGroup.costSplitMaxFixedPriceCents

integer | null

Cost split max fixed price in cents

Example:

10000

job.optionsGroup.costSplitMaxPercentage

number | null

Cost split max percentage

Example:

0.1

job.optionsGroup.costSplitStrategy

string | null

Cost split strategy

Example:

"price"

job.optionsGroup.smartReassignment

boolean | null

Smart reassignment

Example:

true

job.shortReferenceCode

string | null

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

Example:

"0123456"

job.selectedConfiguration

object | null

deprecated

Selected configuration

job.selectedConfiguration.{key}

object[]

Generic serializer for tasks used in many endpoints.

job.selectedConfiguration.{key}.id

string

required

Task ID

Example:

"tsk_01234567890"

job.selectedConfiguration.{key}.createdAt

string

required

Created at

Example:

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

job.selectedConfiguration.{key}.status

string

required

Status

Example:

"running"

job.selectedConfiguration.{key}.pickupStartTime

string | null

Pickup start time

Example:

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

job.selectedConfiguration.{key}.pickupEndTime

string | null

Pickup end time

Example:

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

job.selectedConfiguration.{key}.dropoffStartTime

string | null

Dropoff start time

Example:

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

job.selectedConfiguration.{key}.dropoffEndTime

string | null

Dropoff end time

Example:

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

job.selectedConfiguration.{key}.providerId

string | null

Provider ID

Example:

"prv_01234567890"

job.selectedConfiguration.{key}.providerIsInternal

boolean | null

Provider is internal

Example:

true

job.selectedConfiguration.{key}.tipAmountCents

integer | null

Tip amount in cents

Example:

100

job.selectedConfiguration.{key}.winnerQuote

object | null

Winner quote

Example:

{
  "id": "qot_01234567890",
  "price_cents": 100
}

job.selectedConfiguration.{key}.quotes

object[] | null

Quotes

Generic serializer for quotes used in many endpoints.

job.selectedConfiguration.{key}.quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

job.selectedConfiguration.{key}.quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

job.selectedConfiguration.{key}.quotes.providerName

string

required

Provider name

Example:

"Nash"

job.selectedConfiguration.{key}.quotes.createdTime

string

required

Created time

Example:

"2021-01-01T00:00:00Z"

job.selectedConfiguration.{key}.quotes.priceCents

integer

required

Price in cents

Example:

1000

job.selectedConfiguration.{key}.quotes.type

string | null

Quote type

job.selectedConfiguration.{key}.quotes.providerLogo

string | null

Provider logo

Example:

"https://nash.com/logo.png"

job.selectedConfiguration.{key}.quotes.providerIsInternal

boolean | null

Is the provider internal

job.selectedConfiguration.{key}.quotes.expireTime

string | null

Expire time

Example:

"2021-01-01T00:00:00Z"

job.selectedConfiguration.{key}.quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

job.selectedConfiguration.{key}.quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

job.selectedConfiguration.{key}.quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

job.selectedConfiguration.{key}.quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

job.selectedConfiguration.{key}.quotes.currency

string | null

Currency

Example:

"USD"

job.selectedConfiguration.{key}.quotes.pickupWindow

string | null

Pickup window

Example:

"2021-01-01T00:00:00Z"

job.selectedConfiguration.{key}.quotes.dropoffEta

string | null

Dropoff ETA

Example:

"2021-01-01T00:00:00Z"

job.selectedConfiguration.{key}.quotes.tags

string[] | null

Tags

Example:

["tag1", "tag2"]

job.selectedConfiguration.{key}.quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

job.selectedConfiguration.{key}.quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

job.selectedConfiguration.{key}.quotes.totalPriceBreakdown

object | null

Total price breakdown

Example:

{
  "subtotal": 1000,
  "tax": 100,
  "total": 1100
}

job.selectedConfiguration.{key}.quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

job.selectedConfiguration.{key}.quotes.price

number | null

Price

Example:

1000

job.selectedConfiguration.{key}.quotes.isSuccessful

boolean | null

Is successful

Example:

true

job.selectedConfiguration.{key}.quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

[
  {
    "id": "qot_01234567890",
    "price_cents": 100
  }
]

job.selectedConfiguration.{key}.failedQuotes

object[] | null

Failed quotes

Example:

[
  {
    "id": "qot_01234567890",
    "price_cents": 100
  }
]

job.selectedConfiguration.{key}.delivery

object | null

Delivery object

job.selectedConfiguration.{key}.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

job.selectedConfiguration.{key}.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

job.selectedConfiguration.{key}.delivery.isActive

boolean

required

Is the delivery active

job.selectedConfiguration.{key}.delivery.priceCents

integer

required

Price in cents

job.selectedConfiguration.{key}.delivery.currency

string

required

Currency

job.selectedConfiguration.{key}.delivery.type

string | null

job.selectedConfiguration.{key}.delivery.statusHistory

object[] | null

Delivery status history

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "status": "created"
  },
  {
    "created_at": "2023-08-29T19:17:47.509265",
    "status": "not_assigned_driver"
  }
]

job.selectedConfiguration.{key}.delivery.pickupEta

string | null

Pickup ETA

job.selectedConfiguration.{key}.delivery.dropoffEta

string | null

Dropoff ETA

job.selectedConfiguration.{key}.delivery.dropoffDeadline

string | null

Dropoff deadline

job.selectedConfiguration.{key}.delivery.documents

object[] | null

Documents

Generic serializer for Nash documents; Used for output.

job.selectedConfiguration.{key}.delivery.nashFeeCents

integer | null

Nash fee in cents

job.selectedConfiguration.{key}.delivery.courierName

string | null

Courier name

job.selectedConfiguration.{key}.delivery.courierPhoneNumber

string | null

Courier phone number

job.selectedConfiguration.{key}.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

job.selectedConfiguration.{key}.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

job.selectedConfiguration.{key}.delivery.courierLocation

object | null

Courier location

job.selectedConfiguration.{key}.delivery.courierVehicle

object | null

Courier vehicle

job.selectedConfiguration.{key}.delivery.courierProfileImage

string | null

Courier profile image

job.selectedConfiguration.{key}.delivery.proofOfDelivery

object[] | null

Proof of delivery

job.selectedConfiguration.{key}.delivery.providerDeliveryId

string | null

Provider delivery id

job.selectedConfiguration.{key}.delivery.providerBatchId

string | null

Provider batch id

job.selectedConfiguration.{key}.delivery.price

number | null

Price

job.selectedConfiguration.{key}.delivery.taxAmountCents

integer | null

Tax amount in cents

job.selectedConfiguration.{key}.delivery.tollFeeCents

integer | null

Toll fee in cents

job.selectedConfiguration.{key}.delivery.waitFeeCents

integer | null

Wait fee in cents

job.selectedConfiguration.{key}.delivery.waitTimeMinutes

integer | null

Wait time in minutes

job.selectedConfiguration.{key}.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

job.selectedConfiguration.{key}.delivery.returnFeeCents

integer | null

Return fee in cents

job.selectedConfiguration.{key}.delivery.otherProviderFees

object | null

Other provider fees

job.selectedConfiguration.{key}.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

job.selectedConfiguration.{key}.delivery.totalPriceBreakdown

object | null

Total price breakdown

job.selectedConfiguration.{key}.delivery.totalPriceCents

integer | null

Total price in cents

job.selectedConfiguration.{key}.tipAmountUsd

number | null

Tip amount in USD

Example:

100

job.selectedConfiguration.{key}.failureReason

string | null

Failure reason

Example:

"Task failed"

job.selectedConfiguration.{key}.taskNotes

object[] | null

Task notes

Generic serializer for notes used in many endpoints.

job.selectedConfiguration.{key}.taskNotes.id

string

required

Note ID

Example:

"not_01234567890"

job.selectedConfiguration.{key}.taskNotes.createdAt

string

required

Created at

Example:

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

job.selectedConfiguration.{key}.taskNotes.note

string

required

Note

Example:

"Task note"

job.selectedConfiguration.{key}.taskNotes.user

object | null

required

User

Example:

{ "email": "john.doe@example.com" }

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "id": "not_01234567890",
    "note": "Task note",
    "user": { "email": "john.doe@example.com" }
  }
]

Example:

{ "tasks": [] }

job.jobSpecification

object | null

deprecated

Job specification

job.jobSpecification.{key}

object[]

Generic serializer for packages used in many endpoints; Used for output.

job.jobSpecification.{key}.id

string

required

Package ID

Example:

"pkg_01234567890"

job.jobSpecification.{key}.requirements

string[]

required

Requirements

Example:

[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]

job.jobSpecification.{key}.valueCents

integer

required

job.jobSpecification.{key}.itemsCount

required

Items count

Example:

100

job.jobSpecification.{key}.pickupLocation

object

required

Generic serializer for location used in many endpoints.

job.jobSpecification.{key}.dropoffLocation

object

required

Generic serializer for location used in many endpoints.

job.jobSpecification.{key}.description

string | null

Description

Example:

"Package description"

job.jobSpecification.{key}.tags

string[] | null

Tags

Example:

["Alcohol"]

job.jobSpecification.{key}.packageDeliveryMode

string | null

Package delivery mode

Example:

"now"

job.jobSpecification.{key}.pickupStartTime

string | null

Pickup start time

Example:

"2021-01-01T00:00:00Z"

job.jobSpecification.{key}.pickupEndTime

string | null

Pickup end time

Example:

"2021-01-01T00:00:00Z"

job.jobSpecification.{key}.pickupBarcodes

string[] | null

job.jobSpecification.{key}.dropoffStartTime

string | null

Dropoff start time

Example:

"2021-01-01T00:00:00Z"

job.jobSpecification.{key}.dropoffEndTime

string | null

Dropoff end time

Example:

"2021-01-01T00:00:00Z"

job.jobSpecification.{key}.dropoffBarcodes

string[] | null

job.jobSpecification.{key}.taxCents

integer | null

Tax in cents

Example:

100

job.jobSpecification.{key}.serviceFeeCents

integer | null

Service fee in cents

Example:

100

job.jobSpecification.{key}.externalIdentifier

string | null

External identifier

Example:

"mini-mart-order-99"

job.jobSpecification.{key}.minimumVehicleSize

string | null

Minimum vehicle size

Example:

"car"

job.jobSpecification.{key}.pickupStoreLocationId

string | null

Pickup store location ID

Example:

"store_01234567890"

job.jobSpecification.{key}.dropoffStoreLocationId

string | null

Dropoff store location ID

Example:

"store_01234567890"

job.jobSpecification.{key}.drivingMetrics

object | null

Driving metrics (distance in meters, duration in seconds)

Example:

{ "distance": 100, "duration": 100 }

job.jobSpecification.{key}.value

number | null

Value

Example:

100

job.jobSpecification.{key}.tax

Tax

Example:

100

job.jobSpecification.{key}.serviceFee

Service fee

Example:

100

job.jobSpecification.{key}.tipAmountCents

integer | null

job.jobSpecification.{key}.weight

Weight

Example:

100

job.jobSpecification.{key}.dimensions

object | null

Dimensions

Example:

{
  "height": 100,
  "length": 100,
  "width": 100
}

job.jobSpecification.{key}.items

object[] | null

Items

Example:

[
  {
    "count": 1,
    "description": "Item 1",
    "valueCents": 100
  }
]

job.jobSpecification.{key}.referenceId

string | null

Reference ID

Example:

"mini-mart-order-99"

job.jobSpecification.{key}.packageMetadata

object | null

Package metadata

Example:

{ "key": "value" }

Example:

{ "packages": [] }

Update Batch Job Refresh Quotes (Batch)

curl --request POST \
  --url https://api.sandbox.usenash.com/v1/select_quote \
  --header 'Content-Type: application/json' \
  --data '{
  "quoteId": "qot_01234567890"
}'

{
  "job": {
    "id": "job_01234567890",
    "createdAt": "2023-08-29T19:17:46.264523",
    "portalUrl": "https://usenash.com/portal/job_abc123",
    "externalIdentifier": "mini-mart-order-99",
    "jobMetadata": {
      "key": "value"
    },
    "isActive": true,
    "isBatch": false,
    "jobConfigurations": [
      {
        "id": "cfg_01234567890",
        "package": {
          "id": "pkg_01234567890",
          "description": "Package description",
          "requirements": [
            "photo_proof_of_delivery",
            "age_verification_on_delivery"
          ],
          "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>"
          ],
          "valueCents": 123,
          "taxCents": 100,
          "serviceFeeCents": 100,
          "itemsCount": 100,
          "externalIdentifier": "mini-mart-order-99",
          "minimumVehicleSize": "car",
          "pickupLocation": {
            "id": "loc_01234567890",
            "address": "1600 Amphitheatre Parkway",
            "formattedAddress": "1600 Amphitheatre Parkway",
            "addressNumber": "1600",
            "addressFormattedStreet": "Amphitheatre Parkway",
            "addressCity": "Mountain View",
            "addressCounty": "Santa Clara",
            "addressState": "CA",
            "addressZip": "94043",
            "addressCountry": "US",
            "timezoneId": "America/Los_Angeles",
            "timezoneName": "Pacific Time",
            "instructions": "Turn left on Main St",
            "businessName": "Nash",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "+15555555555",
            "email": "john.doe@example.com"
          },
          "pickupStoreLocationId": "store_01234567890",
          "dropoffLocation": {
            "id": "loc_01234567890",
            "address": "1600 Amphitheatre Parkway",
            "formattedAddress": "1600 Amphitheatre Parkway",
            "addressNumber": "1600",
            "addressFormattedStreet": "Amphitheatre Parkway",
            "addressCity": "Mountain View",
            "addressCounty": "Santa Clara",
            "addressState": "CA",
            "addressZip": "94043",
            "addressCountry": "US",
            "timezoneId": "America/Los_Angeles",
            "timezoneName": "Pacific Time",
            "instructions": "Turn left on Main St",
            "businessName": "Nash",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "+15555555555",
            "email": "john.doe@example.com"
          },
          "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",
              "type": "<string>",
              "status": "dropoff_complete",
              "statusHistory": [
                {
                  "created_at": "2023-08-29T19:17:46.264523",
                  "status": "created"
                },
                {
                  "created_at": "2023-08-29T19:17:47.509265",
                  "status": "not_assigned_driver"
                }
              ],
              "isActive": true,
              "pickupEta": "<string>",
              "dropoffEta": "<string>",
              "dropoffDeadline": "<string>",
              "priceCents": 123,
              "currency": "<string>",
              "documents": [
                {
                  "createdAt": "<string>",
                  "id": "<string>",
                  "type": "<string>",
                  "url": "<string>",
                  "contentType": "<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
            },
            "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",
            "type": "<string>",
            "status": "dropoff_complete",
            "statusHistory": [
              {
                "created_at": "2023-08-29T19:17:46.264523",
                "status": "created"
              },
              {
                "created_at": "2023-08-29T19:17:47.509265",
                "status": "not_assigned_driver"
              }
            ],
            "isActive": true,
            "pickupEta": "<string>",
            "dropoffEta": "<string>",
            "dropoffDeadline": "<string>",
            "priceCents": 123,
            "currency": "<string>",
            "documents": [
              {
                "createdAt": "<string>",
                "id": "<string>",
                "type": "<string>",
                "url": "<string>",
                "contentType": "<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
          },
          "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",
          "type": "<string>",
          "status": "dropoff_complete",
          "statusHistory": [
            {
              "created_at": "2023-08-29T19:17:46.264523",
              "status": "created"
            },
            {
              "created_at": "2023-08-29T19:17:47.509265",
              "status": "not_assigned_driver"
            }
          ],
          "isActive": true,
          "pickupEta": "<string>",
          "dropoffEta": "<string>",
          "dropoffDeadline": "<string>",
          "priceCents": 123,
          "currency": "<string>",
          "documents": [
            {
              "createdAt": "<string>",
              "id": "<string>",
              "type": "<string>",
              "url": "<string>",
              "contentType": "<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
        },
        "publicTrackingUrl": "https://usenash.com/tracking/job_abc123"
      }
    ],
    "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": []
    }
  }
}

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Miscellaneous

Select Quote (Batch)

Body

Response