Create Job

This endpoint is deprecated. Please use the Create Order endpoint instead.

Scheduled Job Time Calculations

When creating a scheduled job, you must include at least one of the following fields:

packagePickupStartTime
packagePickupEndTime
packageDropoffStartTime
packageDropoffEndTime

Times that are not specified will be calculated by Nash. “Now” or ASAP jobs do not require any of these fields. If the specified pickup time of a scheduled job is very close to the current time (within 5 minutes in the past or 10 minutes in the future), it will be automatically transformed into an ASAP job.

For this and all other endpoints, as Nash processes fields from different providers, please assume that any field in the response we provide may be null.

Package Items

An array of item objects, each describing an item within the package for delivery. Each object should include the item’s name, dimensions (length, width, height), and count, providing a detailed inventory of the package’s contents. This information is used to ensure accurate handling and space allocation for transport. Package Items

Note that it’s still highly recommended to include both pickup and dropoff times since our estimations are based on historical time data rather than real-time metrics.

The fields selectedConfiguration and jobSpecification returned in the job response are deprecated and not recommended to be used.Migration guide, replace:jobSpecification->package with data->jobConfiguration[0]->packageand selectedConfiguration with jobConfiguration[0]

Authorizations

Authorization

string

header

required

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

Body

application/json

Expected payload for creating a job.

packageDeliveryMode

string

required

pickupAddress

string | null

The full address in one line for the pickup location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code], [country]. All address fields are required except "second line". Second line should include Apt/Suite/Unit/# appended to the number of the unit.

pickupAddressComponents

ParsedAddressInputSerializer · object

Parsed address input serializer for creating a job.

Show child attributes

pickupAddressComponents.street

string

required

The street of the address. If your geocoding service does not split numbers from street names, you can pass the street name with the number in this field. Example: 1600 Pennsylvania Avenue NW.

Example:

"Pennsylvania Avenue NW"

pickupAddressComponents.city

string

required

The city of the address.

Example:

"Washington"

pickupAddressComponents.country

string

required

The country of the address.

Example:

"US"

pickupAddressComponents.number

string | null

The number of the address.

Example:

"1600"

pickupAddressComponents.secondaryNumber

string | null

The secondary number of the address.

Example:

null

pickupAddressComponents.county

string | null

The county of the address.

Example:

"Washington"

pickupAddressComponents.state

string | null

The state of the address.

Example:

"DC"

pickupAddressComponents.postalCode

string | null

The postal code of the address.

Example:

"20500"

pickupAddressComponents.latitude

number | null

The latitude of the address.

Example:

38.8948949

pickupAddressComponents.longitude

number | null

The longitude of the address.

Example:

-77.0371581

pickupLatitude

number | null

pickupLongitude

number | null

pickupBusinessName

string | null

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

pickupFirstName

string | null

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

pickupLastName

string | null

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

pickupPlaceId

string | null

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

pickupStoreLocationId

string | null

The Nash store location ID for the pickup location.

pickupPhoneNumber

string | null

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

pickupEmail

string | null

pickupBarcodes

string[] | null

dropoffAddress

string | null

The full address in one line for the dropoff location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state], [zip code], [country]. All address fields are required except "second line". Second line should include Apt/Suite/Unit/# appended to the number of the unit.

dropoffAddressComponents

ParsedAddressInputSerializer · object

Parsed address input serializer for creating a job.

Show child attributes

dropoffAddressComponents.street

string

required

The street of the address. If your geocoding service does not split numbers from street names, you can pass the street name with the number in this field. Example: 1600 Pennsylvania Avenue NW.

Example:

"Pennsylvania Avenue NW"

dropoffAddressComponents.city

string

required

The city of the address.

Example:

"Washington"

dropoffAddressComponents.country

string

required

The country of the address.

Example:

"US"

dropoffAddressComponents.number

string | null

The number of the address.

Example:

"1600"

dropoffAddressComponents.secondaryNumber

string | null

The secondary number of the address.

Example:

null

dropoffAddressComponents.county

string | null

The county of the address.

Example:

"Washington"

dropoffAddressComponents.state

string | null

The state of the address.

Example:

"DC"

dropoffAddressComponents.postalCode

string | null

The postal code of the address.

Example:

"20500"

dropoffAddressComponents.latitude

number | null

The latitude of the address.

Example:

38.8948949

dropoffAddressComponents.longitude

number | null

The longitude of the address.

Example:

-77.0371581

dropoffLatitude

number | null

dropoffLongitude

number | null

dropoffFirstName

string | null

dropoffLastName

string | null

dropoffPhoneNumber

string | null

dropoffEmail

string | null

dropoffStoreLocationId

string | null

dropoffExternalStoreLocationId

string | null

dropoffBarcodes

string[] | null

pickupInstructions

string | null

Any special instructions for pickup. Limited to 280 characters. Nash Recommended Input: Pickup order [insert order number] for [insert customer name] from [pickup business name].

dropoffBusinessName

string | null

dropoffInstructions

string | null

dropoffPlaceId

string | null

packagePickupStartTime

string | null

packagePickupEndTime

string | null

packageDropoffStartTime

string | null

packageDropoffEndTime

string | null

packageDescription

string | null

packageValue

number | null

packageValueCents

integer | null

packageTax

packageServiceFee

tipAmount

tipAmountCents

integer | null

tipAmountUsd

number | null

currency

string | null

itemsCount

packageExternalIdentifier

string | null

packageMinimumVehicleSize

enum<string>

Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']

Available options:

any,

bike,

motorbike,

cargobike,

sedan,

car,

suv,

pickup_truck,

pickup,

van,

large_van,

extra_large_van,

truck

Example:

"car"

packageRequirements

(enum<string> | string)[] | null

Package requirements.

Detailed description: https://docs.usenash.com/reference/package-requirements.

Available options:

photo_proof_of_delivery,

signature_proof_of_delivery,

photo_proof_of_pickup,

signature_proof_of_pickup,

photo_pre_delivery_verification,

age_verification_on_delivery,

id_verification_on_delivery,

barcode_scan_on_pickup,

barcode_scan_on_dropoff,

meet_on_delivery,

shipping_label,

two_person_team,

pincode_verification,

schedule_ii_controlled_substances,

alcohol,

tobacco,

parking_check_in,

display_barcode_on_pickup,

pick_and_pack

Example:

[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]

weight

dimensions

Dimensions · object

packageItems

Packageitems · object[] | null

referenceId

string | null

externalIdentifier

string | null

External identifier for the job.

Example:

"mini-mart-order-99"

optionsGroupId

string | null

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

Example:

"dss_1yMhHj"

jobMetadata

Jobmetadata · object

Job metadata for the job.

Example:

{ "key": "value" }

inputDatetimesLocalizedToPickupTz

boolean

default:false

Whether the input datetimes are localized to the pickup timezone.

quoteRequestOnly

boolean

default:false

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

Response

A Nash Job.

string

required

Job ID

Example:

"job_01234567890"

createdAt

string

required

Created at

Example:

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

portalUrl

string

required

Portal URL

Example:

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

isActive

boolean

required

Is the job active

Example:

true

isBatch

boolean

required

Is the job a batch

Example:

false

jobConfigurations

JobConfigurationsSerializer · object[]

required

Job configurations

Show child attributes

jobConfigurations.id

string

required

Job Configuration ID

Example:

"cfg_01234567890"

jobConfigurations.package

PackageSerializer · object

required

Package

Show child attributes

jobConfigurations.package.id

string

required

Package ID

Example:

"pkg_01234567890"

jobConfigurations.package.requirements

string[]

required

Requirements

Example:

[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]

jobConfigurations.package.valueCents

integer

required

jobConfigurations.package.itemsCount

required

Items count

Example:

100

jobConfigurations.package.pickupLocation

LocationSerializer · object

required

Generic serializer for location used in many endpoints.

Show child attributes

jobConfigurations.package.pickupLocation.id

string

required

Location ID

Example:

"loc_01234567890"

jobConfigurations.package.pickupLocation.address

string

required

Address

Example:

"1600 Amphitheatre Parkway"

jobConfigurations.package.pickupLocation.formattedAddress

string

required

Formatted address

Example:

"1600 Amphitheatre Parkway"

jobConfigurations.package.pickupLocation.addressCity

string

required

Address city

Example:

"Mountain View"

jobConfigurations.package.pickupLocation.addressCountry

string

required

Address country

Example:

"US"

jobConfigurations.package.pickupLocation.timezoneId

string

required

Timezone ID

Example:

"America/Los_Angeles"

jobConfigurations.package.pickupLocation.timezoneName

string

required

Timezone name

Example:

"Pacific Time"

jobConfigurations.package.pickupLocation.addressNumber

string | null

Address number

Example:

"1600"

jobConfigurations.package.pickupLocation.addressFormattedStreet

string | null

Address formatted street

Example:

"Amphitheatre Parkway"

jobConfigurations.package.pickupLocation.addressCounty

string | null

Address county

Example:

"Santa Clara"

jobConfigurations.package.pickupLocation.addressState

string | null

Address state

Example:

"CA"

jobConfigurations.package.pickupLocation.addressZip

string | null

Address zip

Example:

"94043"

jobConfigurations.package.pickupLocation.instructions

string | null

Instructions

Example:

"Turn left on Main St"

jobConfigurations.package.pickupLocation.businessName

string | null

Business name

Example:

"Nash"

jobConfigurations.package.pickupLocation.firstName

string | null

First name

Example:

"John"

jobConfigurations.package.pickupLocation.lastName

string | null

Last name

Example:

"Doe"

jobConfigurations.package.pickupLocation.phoneNumber

string | null

Phone number

Example:

"+15555555555"

jobConfigurations.package.pickupLocation.email

string | null

Example:

"[email protected]"

jobConfigurations.package.pickupLocation.lat

number | null

Latitude

Example:

37.774929

jobConfigurations.package.pickupLocation.lng

number | null

Longitude

Example:

-122.419416

jobConfigurations.package.dropoffLocation

LocationSerializer · object

required

Generic serializer for location used in many endpoints.

Show child attributes

jobConfigurations.package.dropoffLocation.id

string

required

Location ID

Example:

"loc_01234567890"

jobConfigurations.package.dropoffLocation.address

string

required

Address

Example:

"1600 Amphitheatre Parkway"

jobConfigurations.package.dropoffLocation.formattedAddress

string

required

Formatted address

Example:

"1600 Amphitheatre Parkway"

jobConfigurations.package.dropoffLocation.addressCity

string

required

Address city

Example:

"Mountain View"

jobConfigurations.package.dropoffLocation.addressCountry

string

required

Address country

Example:

"US"

jobConfigurations.package.dropoffLocation.timezoneId

string

required

Timezone ID

Example:

"America/Los_Angeles"

jobConfigurations.package.dropoffLocation.timezoneName

string

required

Timezone name

Example:

"Pacific Time"

jobConfigurations.package.dropoffLocation.addressNumber

string | null

Address number

Example:

"1600"

jobConfigurations.package.dropoffLocation.addressFormattedStreet

string | null

Address formatted street

Example:

"Amphitheatre Parkway"

jobConfigurations.package.dropoffLocation.addressCounty

string | null

Address county

Example:

"Santa Clara"

jobConfigurations.package.dropoffLocation.addressState

string | null

Address state

Example:

"CA"

jobConfigurations.package.dropoffLocation.addressZip

string | null

Address zip

Example:

"94043"

jobConfigurations.package.dropoffLocation.instructions

string | null

Instructions

Example:

"Turn left on Main St"

jobConfigurations.package.dropoffLocation.businessName

string | null

Business name

Example:

"Nash"

jobConfigurations.package.dropoffLocation.firstName

string | null

First name

Example:

"John"

jobConfigurations.package.dropoffLocation.lastName

string | null

Last name

Example:

"Doe"

jobConfigurations.package.dropoffLocation.phoneNumber

string | null

Phone number

Example:

"+15555555555"

jobConfigurations.package.dropoffLocation.email

string | null

Example:

"[email protected]"

jobConfigurations.package.dropoffLocation.lat

number | null

Latitude

Example:

37.774929

jobConfigurations.package.dropoffLocation.lng

number | null

Longitude

Example:

-122.419416

jobConfigurations.package.description

string | null

Description

Example:

"Package description"

jobConfigurations.package.tags

string[] | null

Tags

Example:

["Alcohol"]

jobConfigurations.package.packageDeliveryMode

string | null

Package delivery mode

Example:

"now"

jobConfigurations.package.pickupStartTime

string | null

Pickup start time

Example:

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

jobConfigurations.package.pickupEndTime

string | null

Pickup end time

Example:

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

jobConfigurations.package.pickupBarcodes

string[] | null

jobConfigurations.package.dropoffStartTime

string | null

Dropoff start time

Example:

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

jobConfigurations.package.dropoffEndTime

string | null

Dropoff end time

Example:

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

jobConfigurations.package.dropoffBarcodes

string[] | null

jobConfigurations.package.taxCents

integer | null

Tax in cents

Example:

100

jobConfigurations.package.serviceFeeCents

integer | null

Service fee in cents

Example:

100

jobConfigurations.package.externalIdentifier

string | null

External identifier

Example:

"mini-mart-order-99"

jobConfigurations.package.minimumVehicleSize

enum<string>

Available options:

any,

bike,

motorbike,

cargobike,

sedan,

car,

suv,

pickup_truck,

pickup,

van,

large_van,

extra_large_van,

truck

Example:

"car"

jobConfigurations.package.pickupStoreLocationId

string | null

Pickup store location ID

Example:

"store_01234567890"

jobConfigurations.package.pickupStoreLocationExternalId

string | null

Pickup store location external ID

Example:

"0123"

jobConfigurations.package.dropoffStoreLocationId

string | null

Dropoff store location ID

Example:

"store_01234567890"

jobConfigurations.package.drivingMetrics

Drivingmetrics · object

Driving metrics (distance in meters, duration in seconds)

Example:

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

jobConfigurations.package.value

number | null

Value

Example:

100

jobConfigurations.package.tax

Tax

Example:

100

jobConfigurations.package.serviceFee

Service fee

Example:

100

jobConfigurations.package.tipAmountCents

integer | null

jobConfigurations.package.weight

Weight

Example:

100

jobConfigurations.package.dimensions

Dimensions · object

Dimensions

Example:

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

jobConfigurations.package.items

ItemOutput · object[] | null

Items

Show child attributes

jobConfigurations.package.items.id

string | null

The merchant ID of the item

Example:

"abc-123"

jobConfigurations.package.items.description

string | null

The description of the item

Example:

"A box of books"

jobConfigurations.package.items.count

integer

default:1

The quantity of the item

Example:

2

jobConfigurations.package.items.dimensions

Dimensions · object

The dimensions of the item

Show child attributes

jobConfigurations.package.items.dimensions.height

The height of the item in centimeters (cm)

Example:

10

jobConfigurations.package.items.dimensions.width

The width of the item in centimeters (cm)

Example:

12

jobConfigurations.package.items.dimensions.depth

The depth of the item in centimeters (cm)

Example:

14

Example:

{ "depth": 14, "height": 10, "width": 12 }

jobConfigurations.package.items.weight

The weight of the item in kilograms (kg)

Example:

1.5

jobConfigurations.package.items.valueCents

integer | null

The value of the item in cents

Example:

1000

jobConfigurations.package.items.subItems

SubItemOutput · object[] | null

The nested sub-items

Show child attributes

jobConfigurations.package.items.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

jobConfigurations.package.items.subItems.description

string | null

The description of the item

Example:

"A box of books"

jobConfigurations.package.items.subItems.count

integer

default:1

The quantity of the item

Example:

2

jobConfigurations.package.items.subItems.dimensions

Dimensions · object

The dimensions of the item

Show child attributes

jobConfigurations.package.items.subItems.dimensions.height

The height of the item in centimeters (cm)

Example:

10

jobConfigurations.package.items.subItems.dimensions.width

The width of the item in centimeters (cm)

Example:

12

jobConfigurations.package.items.subItems.dimensions.depth

The depth of the item in centimeters (cm)

Example:

14

Example:

{ "depth": 14, "height": 10, "width": 12 }

jobConfigurations.package.items.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

jobConfigurations.package.items.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

jobConfigurations.package.items.subItems.sku

string | null

The SKU of the sub-item

jobConfigurations.package.items.subItems.substitution

SubstitutionObject · object

Substitution information for the sub-item

Show child attributes

jobConfigurations.package.items.subItems.substitution.preference

string | null

Substitution preference: refund or substitute

jobConfigurations.package.items.subItems.substitution.source

string | null

Source of substitution, e.g., merchant, customer

jobConfigurations.package.items.subItems.substitution.substituteItems

SubstituteItemObject · object[] | null

List of substitute items

Show child attributes

jobConfigurations.package.items.subItems.substitution.substituteItems.id

string | null

The ID of the substitute item

jobConfigurations.package.items.subItems.substitution.substituteItems.sku

string | null

The SKU of the substitute item

jobConfigurations.package.items.subItems.substitution.substituteItems.quantity

integer | null

The quantity of the substitute item

jobConfigurations.package.items.subItems.subItems

any | null

The nested sub-items

Example:

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

jobConfigurations.package.referenceId

string | null

Reference ID

Example:

"mini-mart-order-99"

jobConfigurations.package.packageMetadata

Packagemetadata · object

Package metadata

Example:

{ "key": "value" }

jobConfigurations.tasks

TaskSerializer · object[]

required

Tasks

Show child attributes

jobConfigurations.tasks.id

string

required

Task ID

Example:

"tsk_01234567890"

jobConfigurations.tasks.createdAt

string

required

Created at

Example:

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

jobConfigurations.tasks.status

string

required

Status

Example:

"running"

jobConfigurations.tasks.pickupStartTime

string | null

Pickup start time

Example:

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

jobConfigurations.tasks.pickupEndTime

string | null

Pickup end time

Example:

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

jobConfigurations.tasks.dropoffStartTime

string | null

Dropoff start time

Example:

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

jobConfigurations.tasks.dropoffEndTime

string | null

Dropoff end time

Example:

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

jobConfigurations.tasks.providerId

string | null

Provider ID

Example:

"prv_01234567890"

jobConfigurations.tasks.providerIsInternal

boolean | null

Provider is internal

Example:

true

jobConfigurations.tasks.tipAmountCents

integer | null

Tip amount in cents

Example:

100

jobConfigurations.tasks.winnerQuote

Winnerquote · object

Winner quote

Example:

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

jobConfigurations.tasks.quotes

QuoteSerializer · object[] | null

Quotes

Show child attributes

jobConfigurations.tasks.quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

jobConfigurations.tasks.quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

jobConfigurations.tasks.quotes.providerName

string

required

Provider name

Example:

"Nash"

jobConfigurations.tasks.quotes.createdTime

string

required

Created time

Example:

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

jobConfigurations.tasks.quotes.priceCents

integer

required

Price in cents

Example:

1000

jobConfigurations.tasks.quotes.type

string | null

Quote type

jobConfigurations.tasks.quotes.providerLogo

string | null

Provider logo

Example:

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

jobConfigurations.tasks.quotes.providerIsInternal

boolean | null

Is the provider internal

jobConfigurations.tasks.quotes.expireTime

string | null

Expire time

Example:

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

jobConfigurations.tasks.quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

jobConfigurations.tasks.quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

jobConfigurations.tasks.quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

jobConfigurations.tasks.quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

jobConfigurations.tasks.quotes.currency

string | null

Currency

Example:

"USD"

jobConfigurations.tasks.quotes.pickupWindow

string | null

Pickup window

Example:

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

jobConfigurations.tasks.quotes.dropoffEta

string | null

Dropoff ETA

Example:

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

jobConfigurations.tasks.quotes.tags

string[] | null

Tags

Example:

[
  "tag1",
  "tag2",
  "autodispatch_preferred_quote"
]

jobConfigurations.tasks.quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

jobConfigurations.tasks.quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

jobConfigurations.tasks.quotes.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

Example:

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

jobConfigurations.tasks.quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

jobConfigurations.tasks.quotes.price

number | null

Price

Example:

1000

jobConfigurations.tasks.quotes.isSuccessful

boolean | null

Is successful

Example:

true

jobConfigurations.tasks.quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

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

jobConfigurations.tasks.failedQuotes

Failedquotes · object[] | null

Failed quotes

Example:

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

jobConfigurations.tasks.delivery

DeliverySerializer · object

Delivery object

Show child attributes

jobConfigurations.tasks.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

jobConfigurations.tasks.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

jobConfigurations.tasks.delivery.isActive

boolean

required

Is the delivery active

jobConfigurations.tasks.delivery.priceCents

integer

required

Price in cents

jobConfigurations.tasks.delivery.currency

string

required

Currency

jobConfigurations.tasks.delivery.type

string | null

jobConfigurations.tasks.delivery.statusHistory

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"
  }
]

jobConfigurations.tasks.delivery.pickupEta

string | null

Pickup ETA

jobConfigurations.tasks.delivery.dropoffEta

string | null

Dropoff ETA

jobConfigurations.tasks.delivery.dropoffDeadline

string | null

Dropoff deadline

jobConfigurations.tasks.delivery.documents

DocumentSerializer · object[] | null

Documents

Show child attributes

jobConfigurations.tasks.delivery.documents.createdAt

string

required

jobConfigurations.tasks.delivery.documents.id

string

required

jobConfigurations.tasks.delivery.documents.type

string

required

jobConfigurations.tasks.delivery.documents.contentType

string

required

jobConfigurations.tasks.delivery.documents.url

string | null

jobConfigurations.tasks.delivery.documents.data

file | null

jobConfigurations.tasks.delivery.documents.documentMetadata

Documentmetadata · object

jobConfigurations.tasks.delivery.nashFeeCents

integer | null

Nash fee in cents

jobConfigurations.tasks.delivery.courierName

string | null

Courier name

jobConfigurations.tasks.delivery.courierPhoneNumber

string | null

Courier phone number

jobConfigurations.tasks.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

jobConfigurations.tasks.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

jobConfigurations.tasks.delivery.courierLocation

Courierlocation · object

Courier location

jobConfigurations.tasks.delivery.courierVehicle

Couriervehicle · object

Courier vehicle

jobConfigurations.tasks.delivery.courierProfileImage

string | null

Courier profile image

jobConfigurations.tasks.delivery.proofOfDelivery

Proofofdelivery · object[] | null

Proof of delivery

jobConfigurations.tasks.delivery.providerDeliveryId

string | null

Provider delivery id

jobConfigurations.tasks.delivery.providerBatchId

string | null

Provider batch id

jobConfigurations.tasks.delivery.price

number | null

Price

jobConfigurations.tasks.delivery.taxAmountCents

integer | null

Tax amount in cents

jobConfigurations.tasks.delivery.tollFeeCents

integer | null

Toll fee in cents

jobConfigurations.tasks.delivery.waitFeeCents

integer | null

Wait fee in cents

jobConfigurations.tasks.delivery.waitTimeMinutes

integer | null

Wait time in minutes

jobConfigurations.tasks.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

jobConfigurations.tasks.delivery.returnFeeCents

integer | null

Return fee in cents

jobConfigurations.tasks.delivery.otherProviderFees

Otherproviderfees · object

Other provider fees

jobConfigurations.tasks.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

jobConfigurations.tasks.delivery.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

jobConfigurations.tasks.delivery.totalPriceCents

integer | null

Total price in cents

jobConfigurations.tasks.delivery.pickedItems

PickedItemsSerializer · object[] | null

Picked items

Show child attributes

jobConfigurations.tasks.delivery.pickedItems.sku

string | null

jobConfigurations.tasks.delivery.pickedItems.requestedSku

string | null

jobConfigurations.tasks.delivery.pickedItems.id

string | null

jobConfigurations.tasks.delivery.pickedItems.requestedId

string | null

jobConfigurations.tasks.delivery.pickedItems.quantity

integer | null

jobConfigurations.tasks.delivery.pickedItems.scannedBarcode

string | null

jobConfigurations.tasks.delivery.pickedItems.weight

number | null

jobConfigurations.tasks.delivery.pickedItems.priceCents

integer | null

jobConfigurations.tasks.delivery.pickedItems.status

string | null

jobConfigurations.tasks.delivery.pickedItems.name

string | null

jobConfigurations.tasks.delivery.pickedItems.scans

ItemScanSerializer · object[] | null

Show child attributes

jobConfigurations.tasks.delivery.pickedItems.scans.substitutionType

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes

BarcodeInfoSerializer · object[] | null

Show child attributes

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.weight

number | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.priceCents

integer | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.weightUnit

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.productCode

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.isVariableWeight

boolean | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.barcode

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.variableValue

number | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.format

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.indicatorDigit

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.checkDigit

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.manufacturerCode

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.itemReference

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.pluCheckDigit

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.barcodeSansCheckDigit

string | null

jobConfigurations.tasks.delivery.pickedItems.scans.barcodes.expirationDate

string | null

jobConfigurations.tasks.tipAmountUsd

number | null

Tip amount in USD

Example:

100

jobConfigurations.tasks.failureReason

string | null

Failure reason

Example:

"Task failed"

jobConfigurations.tasks.taskNotes

NoteSerializer · object[] | null

Task notes

Show child attributes

jobConfigurations.tasks.taskNotes.id

string

required

Note ID

Example:

"not_01234567890"

jobConfigurations.tasks.taskNotes.createdAt

string

required

Created at

Example:

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

jobConfigurations.tasks.taskNotes.note

string

required

Note

Example:

"Task note"

jobConfigurations.tasks.taskNotes.user

BasicUserSerializer · object

required

User

Show child attributes

jobConfigurations.tasks.taskNotes.user.email

string

required

Example:

"[email protected]"

Example:

{ "email": "[email protected]" }

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "id": "not_01234567890",
    "note": "Task note",
    "user": { "email": "[email protected]" }
  }
]

jobConfigurations.advancedTask

TaskSerializer · object

Advanced task

TaskSerializer
CompressedAdvancedTaskSerializer

Show child attributes

jobConfigurations.advancedTask.id

string

required

Task ID

Example:

"tsk_01234567890"

jobConfigurations.advancedTask.createdAt

string

required

Created at

Example:

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

jobConfigurations.advancedTask.status

string

required

Status

Example:

"running"

jobConfigurations.advancedTask.pickupStartTime

string | null

Pickup start time

Example:

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

jobConfigurations.advancedTask.pickupEndTime

string | null

Pickup end time

Example:

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

jobConfigurations.advancedTask.dropoffStartTime

string | null

Dropoff start time

Example:

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

jobConfigurations.advancedTask.dropoffEndTime

string | null

Dropoff end time

Example:

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

jobConfigurations.advancedTask.providerId

string | null

Provider ID

Example:

"prv_01234567890"

jobConfigurations.advancedTask.providerIsInternal

boolean | null

Provider is internal

Example:

true

jobConfigurations.advancedTask.tipAmountCents

integer | null

Tip amount in cents

Example:

100

jobConfigurations.advancedTask.winnerQuote

Winnerquote · object

Winner quote

Example:

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

jobConfigurations.advancedTask.quotes

QuoteSerializer · object[] | null

Quotes

Show child attributes

jobConfigurations.advancedTask.quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

jobConfigurations.advancedTask.quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

jobConfigurations.advancedTask.quotes.providerName

string

required

Provider name

Example:

"Nash"

jobConfigurations.advancedTask.quotes.createdTime

string

required

Created time

Example:

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

jobConfigurations.advancedTask.quotes.priceCents

integer

required

Price in cents

Example:

1000

jobConfigurations.advancedTask.quotes.type

string | null

Quote type

jobConfigurations.advancedTask.quotes.providerLogo

string | null

Provider logo

Example:

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

jobConfigurations.advancedTask.quotes.providerIsInternal

boolean | null

Is the provider internal

jobConfigurations.advancedTask.quotes.expireTime

string | null

Expire time

Example:

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

jobConfigurations.advancedTask.quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

jobConfigurations.advancedTask.quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

jobConfigurations.advancedTask.quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

jobConfigurations.advancedTask.quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

jobConfigurations.advancedTask.quotes.currency

string | null

Currency

Example:

"USD"

jobConfigurations.advancedTask.quotes.pickupWindow

string | null

Pickup window

Example:

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

jobConfigurations.advancedTask.quotes.dropoffEta

string | null

Dropoff ETA

Example:

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

jobConfigurations.advancedTask.quotes.tags

string[] | null

Tags

Example:

[
  "tag1",
  "tag2",
  "autodispatch_preferred_quote"
]

jobConfigurations.advancedTask.quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

jobConfigurations.advancedTask.quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

jobConfigurations.advancedTask.quotes.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

Example:

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

jobConfigurations.advancedTask.quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

jobConfigurations.advancedTask.quotes.price

number | null

Price

Example:

1000

jobConfigurations.advancedTask.quotes.isSuccessful

boolean | null

Is successful

Example:

true

jobConfigurations.advancedTask.quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

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

jobConfigurations.advancedTask.failedQuotes

Failedquotes · object[] | null

Failed quotes

Example:

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

jobConfigurations.advancedTask.delivery

DeliverySerializer · object

Delivery object

Show child attributes

jobConfigurations.advancedTask.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

jobConfigurations.advancedTask.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

jobConfigurations.advancedTask.delivery.isActive

boolean

required

Is the delivery active

jobConfigurations.advancedTask.delivery.priceCents

integer

required

Price in cents

jobConfigurations.advancedTask.delivery.currency

string

required

Currency

jobConfigurations.advancedTask.delivery.type

string | null

jobConfigurations.advancedTask.delivery.statusHistory

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"
  }
]

jobConfigurations.advancedTask.delivery.pickupEta

string | null

Pickup ETA

jobConfigurations.advancedTask.delivery.dropoffEta

string | null

Dropoff ETA

jobConfigurations.advancedTask.delivery.dropoffDeadline

string | null

Dropoff deadline

jobConfigurations.advancedTask.delivery.documents

DocumentSerializer · object[] | null

Documents

Show child attributes

jobConfigurations.advancedTask.delivery.documents.createdAt

string

required

jobConfigurations.advancedTask.delivery.documents.id

string

required

jobConfigurations.advancedTask.delivery.documents.type

string

required

jobConfigurations.advancedTask.delivery.documents.contentType

string

required

jobConfigurations.advancedTask.delivery.documents.url

string | null

jobConfigurations.advancedTask.delivery.documents.data

file | null

jobConfigurations.advancedTask.delivery.documents.documentMetadata

Documentmetadata · object

jobConfigurations.advancedTask.delivery.nashFeeCents

integer | null

Nash fee in cents

jobConfigurations.advancedTask.delivery.courierName

string | null

Courier name

jobConfigurations.advancedTask.delivery.courierPhoneNumber

string | null

Courier phone number

jobConfigurations.advancedTask.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

jobConfigurations.advancedTask.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

jobConfigurations.advancedTask.delivery.courierLocation

Courierlocation · object

Courier location

jobConfigurations.advancedTask.delivery.courierVehicle

Couriervehicle · object

Courier vehicle

jobConfigurations.advancedTask.delivery.courierProfileImage

string | null

Courier profile image

jobConfigurations.advancedTask.delivery.proofOfDelivery

Proofofdelivery · object[] | null

Proof of delivery

jobConfigurations.advancedTask.delivery.providerDeliveryId

string | null

Provider delivery id

jobConfigurations.advancedTask.delivery.providerBatchId

string | null

Provider batch id

jobConfigurations.advancedTask.delivery.price

number | null

Price

jobConfigurations.advancedTask.delivery.taxAmountCents

integer | null

Tax amount in cents

jobConfigurations.advancedTask.delivery.tollFeeCents

integer | null

Toll fee in cents

jobConfigurations.advancedTask.delivery.waitFeeCents

integer | null

Wait fee in cents

jobConfigurations.advancedTask.delivery.waitTimeMinutes

integer | null

Wait time in minutes

jobConfigurations.advancedTask.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

jobConfigurations.advancedTask.delivery.returnFeeCents

integer | null

Return fee in cents

jobConfigurations.advancedTask.delivery.otherProviderFees

Otherproviderfees · object

Other provider fees

jobConfigurations.advancedTask.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

jobConfigurations.advancedTask.delivery.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

jobConfigurations.advancedTask.delivery.totalPriceCents

integer | null

Total price in cents

jobConfigurations.advancedTask.delivery.pickedItems

PickedItemsSerializer · object[] | null

Picked items

Show child attributes

jobConfigurations.advancedTask.delivery.pickedItems.sku

string | null

jobConfigurations.advancedTask.delivery.pickedItems.requestedSku

string | null

jobConfigurations.advancedTask.delivery.pickedItems.id

string | null

jobConfigurations.advancedTask.delivery.pickedItems.requestedId

string | null

jobConfigurations.advancedTask.delivery.pickedItems.quantity

integer | null

jobConfigurations.advancedTask.delivery.pickedItems.scannedBarcode

string | null

jobConfigurations.advancedTask.delivery.pickedItems.weight

number | null

jobConfigurations.advancedTask.delivery.pickedItems.priceCents

integer | null

jobConfigurations.advancedTask.delivery.pickedItems.status

string | null

jobConfigurations.advancedTask.delivery.pickedItems.name

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans

ItemScanSerializer · object[] | null

Show child attributes

jobConfigurations.advancedTask.delivery.pickedItems.scans.substitutionType

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes

BarcodeInfoSerializer · object[] | null

Show child attributes

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.weight

number | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.priceCents

integer | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.weightUnit

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.productCode

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.isVariableWeight

boolean | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.barcode

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.variableValue

number | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.format

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.indicatorDigit

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.checkDigit

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.manufacturerCode

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.itemReference

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.pluCheckDigit

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.barcodeSansCheckDigit

string | null

jobConfigurations.advancedTask.delivery.pickedItems.scans.barcodes.expirationDate

string | null

jobConfigurations.advancedTask.tipAmountUsd

number | null

Tip amount in USD

Example:

100

jobConfigurations.advancedTask.failureReason

string | null

Failure reason

Example:

"Task failed"

jobConfigurations.advancedTask.taskNotes

NoteSerializer · object[] | null

Task notes

Show child attributes

jobConfigurations.advancedTask.taskNotes.id

string

required

Note ID

Example:

"not_01234567890"

jobConfigurations.advancedTask.taskNotes.createdAt

string

required

Created at

Example:

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

jobConfigurations.advancedTask.taskNotes.note

string

required

Note

Example:

"Task note"

jobConfigurations.advancedTask.taskNotes.user

BasicUserSerializer · object

required

User

Show child attributes

jobConfigurations.advancedTask.taskNotes.user.email

string

required

Example:

"[email protected]"

Example:

{ "email": "[email protected]" }

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "id": "not_01234567890",
    "note": "Task note",
    "user": { "email": "[email protected]" }
  }
]

jobConfigurations.delivery

DeliverySerializer · object

Delivery

Show child attributes

jobConfigurations.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

jobConfigurations.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

jobConfigurations.delivery.isActive

boolean

required

Is the delivery active

jobConfigurations.delivery.priceCents

integer

required

Price in cents

jobConfigurations.delivery.currency

string

required

Currency

jobConfigurations.delivery.type

string | null

jobConfigurations.delivery.statusHistory

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"
  }
]

jobConfigurations.delivery.pickupEta

string | null

Pickup ETA

jobConfigurations.delivery.dropoffEta

string | null

Dropoff ETA

jobConfigurations.delivery.dropoffDeadline

string | null

Dropoff deadline

jobConfigurations.delivery.documents

DocumentSerializer · object[] | null

Documents

Show child attributes

jobConfigurations.delivery.documents.createdAt

string

required

jobConfigurations.delivery.documents.id

string

required

jobConfigurations.delivery.documents.type

string

required

jobConfigurations.delivery.documents.contentType

string

required

jobConfigurations.delivery.documents.url

string | null

jobConfigurations.delivery.documents.data

file | null

jobConfigurations.delivery.documents.documentMetadata

Documentmetadata · object

jobConfigurations.delivery.nashFeeCents

integer | null

Nash fee in cents

jobConfigurations.delivery.courierName

string | null

Courier name

jobConfigurations.delivery.courierPhoneNumber

string | null

Courier phone number

jobConfigurations.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

jobConfigurations.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

jobConfigurations.delivery.courierLocation

Courierlocation · object

Courier location

jobConfigurations.delivery.courierVehicle

Couriervehicle · object

Courier vehicle

jobConfigurations.delivery.courierProfileImage

string | null

Courier profile image

jobConfigurations.delivery.proofOfDelivery

Proofofdelivery · object[] | null

Proof of delivery

jobConfigurations.delivery.providerDeliveryId

string | null

Provider delivery id

jobConfigurations.delivery.providerBatchId

string | null

Provider batch id

jobConfigurations.delivery.price

number | null

Price

jobConfigurations.delivery.taxAmountCents

integer | null

Tax amount in cents

jobConfigurations.delivery.tollFeeCents

integer | null

Toll fee in cents

jobConfigurations.delivery.waitFeeCents

integer | null

Wait fee in cents

jobConfigurations.delivery.waitTimeMinutes

integer | null

Wait time in minutes

jobConfigurations.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

jobConfigurations.delivery.returnFeeCents

integer | null

Return fee in cents

jobConfigurations.delivery.otherProviderFees

Otherproviderfees · object

Other provider fees

jobConfigurations.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

jobConfigurations.delivery.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

jobConfigurations.delivery.totalPriceCents

integer | null

Total price in cents

jobConfigurations.delivery.pickedItems

PickedItemsSerializer · object[] | null

Picked items

Show child attributes

jobConfigurations.delivery.pickedItems.sku

string | null

jobConfigurations.delivery.pickedItems.requestedSku

string | null

jobConfigurations.delivery.pickedItems.id

string | null

jobConfigurations.delivery.pickedItems.requestedId

string | null

jobConfigurations.delivery.pickedItems.quantity

integer | null

jobConfigurations.delivery.pickedItems.scannedBarcode

string | null

jobConfigurations.delivery.pickedItems.weight

number | null

jobConfigurations.delivery.pickedItems.priceCents

integer | null

jobConfigurations.delivery.pickedItems.status

string | null

jobConfigurations.delivery.pickedItems.name

string | null

jobConfigurations.delivery.pickedItems.scans

ItemScanSerializer · object[] | null

Show child attributes

jobConfigurations.delivery.pickedItems.scans.substitutionType

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes

BarcodeInfoSerializer · object[] | null

Show child attributes

jobConfigurations.delivery.pickedItems.scans.barcodes.weight

number | null

jobConfigurations.delivery.pickedItems.scans.barcodes.priceCents

integer | null

jobConfigurations.delivery.pickedItems.scans.barcodes.weightUnit

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.productCode

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.isVariableWeight

boolean | null

jobConfigurations.delivery.pickedItems.scans.barcodes.barcode

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.variableValue

number | null

jobConfigurations.delivery.pickedItems.scans.barcodes.format

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.indicatorDigit

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.checkDigit

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.manufacturerCode

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.itemReference

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.pluCheckDigit

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.barcodeSansCheckDigit

string | null

jobConfigurations.delivery.pickedItems.scans.barcodes.expirationDate

string | null

jobConfigurations.publicTrackingUrl

string | null

Public tracking URL

Example:

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

externalIdentifier

string | null

External identifier

Example:

"mini-mart-order-99"

jobMetadata

Jobmetadata · object

Job metadata

Example:

{ "key": "value" }

optionsGroup

OptionsGroupSerializer · object

Options group

Show child attributes

optionsGroup.id

string

required

Dispatch Strategy ID

Example:

"opn_WyMhHj"

optionsGroup.label

string

required

Dispatch Strategy Label

Example:

"New York City Strategy"

optionsGroup.allowedProviders

string[] | null

Allowed providers

Example:

["prv_01234567890", "prv_01234567891"]

optionsGroup.enableAutoDispatch

boolean | null

Enable auto dispatch

Example:

true

optionsGroup.providerSelectionStrategy

string | null

Provider selection strategy

Example:

"cheapest"

optionsGroup.reassignOnFailure

boolean | null

Reassign on failure

Example:

true

optionsGroup.enableMaxDeliveryFee

boolean | null

Enable max delivery fee

Example:

true

optionsGroup.maxDeliveryFeeCents

integer | null

Max delivery fee in cents

Example:

10000

optionsGroup.costSplitMaxFixedPriceCents

integer | null

Cost split max fixed price in cents

Example:

10000

optionsGroup.costSplitMaxPercentage

number | null

Cost split max percentage

Example:

0.1

optionsGroup.costSplitStrategy

string | null

Cost split strategy

Example:

"price"

optionsGroup.smartReassignment

boolean | null

Smart reassignment

Example:

true

shortReferenceCode

string | null

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

Example:

"0123456"

selectedConfiguration

Selectedconfiguration · object

deprecated

Selected configuration

Show child attributes

selectedConfiguration.{key}

TaskSerializer · object[]

Show child attributes

selectedConfiguration.{key}.id

string

required

Task ID

Example:

"tsk_01234567890"

selectedConfiguration.{key}.createdAt

string

required

Created at

Example:

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

selectedConfiguration.{key}.status

string

required

Status

Example:

"running"

selectedConfiguration.{key}.pickupStartTime

string | null

Pickup start time

Example:

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

selectedConfiguration.{key}.pickupEndTime

string | null

Pickup end time

Example:

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

selectedConfiguration.{key}.dropoffStartTime

string | null

Dropoff start time

Example:

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

selectedConfiguration.{key}.dropoffEndTime

string | null

Dropoff end time

Example:

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

selectedConfiguration.{key}.providerId

string | null

Provider ID

Example:

"prv_01234567890"

selectedConfiguration.{key}.providerIsInternal

boolean | null

Provider is internal

Example:

true

selectedConfiguration.{key}.tipAmountCents

integer | null

Tip amount in cents

Example:

100

selectedConfiguration.{key}.winnerQuote

Winnerquote · object

Winner quote

Example:

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

selectedConfiguration.{key}.quotes

QuoteSerializer · object[] | null

Quotes

Show child attributes

selectedConfiguration.{key}.quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

selectedConfiguration.{key}.quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

selectedConfiguration.{key}.quotes.providerName

string

required

Provider name

Example:

"Nash"

selectedConfiguration.{key}.quotes.createdTime

string

required

Created time

Example:

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

selectedConfiguration.{key}.quotes.priceCents

integer

required

Price in cents

Example:

1000

selectedConfiguration.{key}.quotes.type

string | null

Quote type

selectedConfiguration.{key}.quotes.providerLogo

string | null

Provider logo

Example:

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

selectedConfiguration.{key}.quotes.providerIsInternal

boolean | null

Is the provider internal

selectedConfiguration.{key}.quotes.expireTime

string | null

Expire time

Example:

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

selectedConfiguration.{key}.quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

selectedConfiguration.{key}.quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

selectedConfiguration.{key}.quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

selectedConfiguration.{key}.quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

selectedConfiguration.{key}.quotes.currency

string | null

Currency

Example:

"USD"

selectedConfiguration.{key}.quotes.pickupWindow

string | null

Pickup window

Example:

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

selectedConfiguration.{key}.quotes.dropoffEta

string | null

Dropoff ETA

Example:

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

selectedConfiguration.{key}.quotes.tags

string[] | null

Tags

Example:

[
  "tag1",
  "tag2",
  "autodispatch_preferred_quote"
]

selectedConfiguration.{key}.quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

selectedConfiguration.{key}.quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

selectedConfiguration.{key}.quotes.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

Example:

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

selectedConfiguration.{key}.quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

selectedConfiguration.{key}.quotes.price

number | null

Price

Example:

1000

selectedConfiguration.{key}.quotes.isSuccessful

boolean | null

Is successful

Example:

true

selectedConfiguration.{key}.quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

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

selectedConfiguration.{key}.failedQuotes

Failedquotes · object[] | null

Failed quotes

Example:

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

selectedConfiguration.{key}.delivery

DeliverySerializer · object

Delivery object

Show child attributes

selectedConfiguration.{key}.delivery.id

string

required

Delivery ID

Example:

"dlv_01234567890"

selectedConfiguration.{key}.delivery.status

string

required

Delivery status

Example:

"dropoff_complete"

selectedConfiguration.{key}.delivery.isActive

boolean

required

Is the delivery active

selectedConfiguration.{key}.delivery.priceCents

integer

required

Price in cents

selectedConfiguration.{key}.delivery.currency

string

required

Currency

selectedConfiguration.{key}.delivery.type

string | null

selectedConfiguration.{key}.delivery.statusHistory

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"
  }
]

selectedConfiguration.{key}.delivery.pickupEta

string | null

Pickup ETA

selectedConfiguration.{key}.delivery.dropoffEta

string | null

Dropoff ETA

selectedConfiguration.{key}.delivery.dropoffDeadline

string | null

Dropoff deadline

selectedConfiguration.{key}.delivery.documents

DocumentSerializer · object[] | null

Documents

Show child attributes

selectedConfiguration.{key}.delivery.documents.createdAt

string

required

selectedConfiguration.{key}.delivery.documents.id

string

required

selectedConfiguration.{key}.delivery.documents.type

string

required

selectedConfiguration.{key}.delivery.documents.contentType

string

required

selectedConfiguration.{key}.delivery.documents.url

string | null

selectedConfiguration.{key}.delivery.documents.data

file | null

selectedConfiguration.{key}.delivery.documents.documentMetadata

Documentmetadata · object

selectedConfiguration.{key}.delivery.nashFeeCents

integer | null

Nash fee in cents

selectedConfiguration.{key}.delivery.courierName

string | null

Courier name

selectedConfiguration.{key}.delivery.courierPhoneNumber

string | null

Courier phone number

selectedConfiguration.{key}.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

selectedConfiguration.{key}.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

selectedConfiguration.{key}.delivery.courierLocation

Courierlocation · object

Courier location

selectedConfiguration.{key}.delivery.courierVehicle

Couriervehicle · object

Courier vehicle

selectedConfiguration.{key}.delivery.courierProfileImage

string | null

Courier profile image

selectedConfiguration.{key}.delivery.proofOfDelivery

Proofofdelivery · object[] | null

Proof of delivery

selectedConfiguration.{key}.delivery.providerDeliveryId

string | null

Provider delivery id

selectedConfiguration.{key}.delivery.providerBatchId

string | null

Provider batch id

selectedConfiguration.{key}.delivery.price

number | null

Price

selectedConfiguration.{key}.delivery.taxAmountCents

integer | null

Tax amount in cents

selectedConfiguration.{key}.delivery.tollFeeCents

integer | null

Toll fee in cents

selectedConfiguration.{key}.delivery.waitFeeCents

integer | null

Wait fee in cents

selectedConfiguration.{key}.delivery.waitTimeMinutes

integer | null

Wait time in minutes

selectedConfiguration.{key}.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

selectedConfiguration.{key}.delivery.returnFeeCents

integer | null

Return fee in cents

selectedConfiguration.{key}.delivery.otherProviderFees

Otherproviderfees · object

Other provider fees

selectedConfiguration.{key}.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

selectedConfiguration.{key}.delivery.totalPriceBreakdown

Totalpricebreakdown · object

Total price breakdown

selectedConfiguration.{key}.delivery.totalPriceCents

integer | null

Total price in cents

selectedConfiguration.{key}.delivery.pickedItems

PickedItemsSerializer · object[] | null

Picked items

Show child attributes

selectedConfiguration.{key}.delivery.pickedItems.sku

string | null

selectedConfiguration.{key}.delivery.pickedItems.requestedSku

string | null

selectedConfiguration.{key}.delivery.pickedItems.id

string | null

selectedConfiguration.{key}.delivery.pickedItems.requestedId

string | null

selectedConfiguration.{key}.delivery.pickedItems.quantity

integer | null

selectedConfiguration.{key}.delivery.pickedItems.scannedBarcode

string | null

selectedConfiguration.{key}.delivery.pickedItems.weight

number | null

selectedConfiguration.{key}.delivery.pickedItems.priceCents

integer | null

selectedConfiguration.{key}.delivery.pickedItems.status

string | null

selectedConfiguration.{key}.delivery.pickedItems.name

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans

ItemScanSerializer · object[] | null

Show child attributes

selectedConfiguration.{key}.delivery.pickedItems.scans.substitutionType

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes

BarcodeInfoSerializer · object[] | null

Show child attributes

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.weight

number | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.priceCents

integer | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.weightUnit

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.productCode

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.isVariableWeight

boolean | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.barcode

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.variableValue

number | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.format

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.indicatorDigit

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.checkDigit

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.manufacturerCode

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.itemReference

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.pluCheckDigit

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.barcodeSansCheckDigit

string | null

selectedConfiguration.{key}.delivery.pickedItems.scans.barcodes.expirationDate

string | null

selectedConfiguration.{key}.tipAmountUsd

number | null

Tip amount in USD

Example:

100

selectedConfiguration.{key}.failureReason

string | null

Failure reason

Example:

"Task failed"

selectedConfiguration.{key}.taskNotes

NoteSerializer · object[] | null

Task notes

Show child attributes

selectedConfiguration.{key}.taskNotes.id

string

required

Note ID

Example:

"not_01234567890"

selectedConfiguration.{key}.taskNotes.createdAt

string

required

Created at

Example:

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

selectedConfiguration.{key}.taskNotes.note

string

required

Note

Example:

"Task note"

selectedConfiguration.{key}.taskNotes.user

BasicUserSerializer · object

required

User

Show child attributes

selectedConfiguration.{key}.taskNotes.user.email

string

required

Example:

"[email protected]"

Example:

{ "email": "[email protected]" }

Example:

[
  {
    "created_at": "2023-08-29T19:17:46.264523",
    "id": "not_01234567890",
    "note": "Task note",
    "user": { "email": "[email protected]" }
  }
]

Example:

{ "tasks": [] }

jobSpecification

Jobspecification · object

deprecated

Job specification

Show child attributes

jobSpecification.{key}

PackageSerializer · object[]

Show child attributes

jobSpecification.{key}.id

string

required

Package ID

Example:

"pkg_01234567890"

jobSpecification.{key}.requirements

string[]

required

Requirements

Example:

[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]

jobSpecification.{key}.valueCents

integer

required

jobSpecification.{key}.itemsCount

required

Items count

Example:

100

jobSpecification.{key}.pickupLocation

LocationSerializer · object

required

Generic serializer for location used in many endpoints.

Show child attributes

jobSpecification.{key}.pickupLocation.id

string

required

Location ID

Example:

"loc_01234567890"

jobSpecification.{key}.pickupLocation.address

string

required

Address

Example:

"1600 Amphitheatre Parkway"

jobSpecification.{key}.pickupLocation.formattedAddress

string

required

Formatted address

Example:

"1600 Amphitheatre Parkway"

jobSpecification.{key}.pickupLocation.addressCity

string

required

Address city

Example:

"Mountain View"

jobSpecification.{key}.pickupLocation.addressCountry

string

required

Address country

Example:

"US"

jobSpecification.{key}.pickupLocation.timezoneId

string

required

Timezone ID

Example:

"America/Los_Angeles"

jobSpecification.{key}.pickupLocation.timezoneName

string

required

Timezone name

Example:

"Pacific Time"

jobSpecification.{key}.pickupLocation.addressNumber

string | null

Address number

Example:

"1600"

jobSpecification.{key}.pickupLocation.addressFormattedStreet

string | null

Address formatted street

Example:

"Amphitheatre Parkway"

jobSpecification.{key}.pickupLocation.addressCounty

string | null

Address county

Example:

"Santa Clara"

jobSpecification.{key}.pickupLocation.addressState

string | null

Address state

Example:

"CA"

jobSpecification.{key}.pickupLocation.addressZip

string | null

Address zip

Example:

"94043"

jobSpecification.{key}.pickupLocation.instructions

string | null

Instructions

Example:

"Turn left on Main St"

jobSpecification.{key}.pickupLocation.businessName

string | null

Business name

Example:

"Nash"

jobSpecification.{key}.pickupLocation.firstName

string | null

First name

Example:

"John"

jobSpecification.{key}.pickupLocation.lastName

string | null

Last name

Example:

"Doe"

jobSpecification.{key}.pickupLocation.phoneNumber

string | null

Phone number

Example:

"+15555555555"

jobSpecification.{key}.pickupLocation.email

string | null

Example:

"[email protected]"

jobSpecification.{key}.pickupLocation.lat

number | null

Latitude

Example:

37.774929

jobSpecification.{key}.pickupLocation.lng

number | null

Longitude

Example:

-122.419416

jobSpecification.{key}.dropoffLocation

LocationSerializer · object

required

Generic serializer for location used in many endpoints.

Show child attributes

jobSpecification.{key}.dropoffLocation.id

string

required

Location ID

Example:

"loc_01234567890"

jobSpecification.{key}.dropoffLocation.address

string

required

Address

Example:

"1600 Amphitheatre Parkway"

jobSpecification.{key}.dropoffLocation.formattedAddress

string

required

Formatted address

Example:

"1600 Amphitheatre Parkway"

jobSpecification.{key}.dropoffLocation.addressCity

string

required

Address city

Example:

"Mountain View"

jobSpecification.{key}.dropoffLocation.addressCountry

string

required

Address country

Example:

"US"

jobSpecification.{key}.dropoffLocation.timezoneId

string

required

Timezone ID

Example:

"America/Los_Angeles"

jobSpecification.{key}.dropoffLocation.timezoneName

string

required

Timezone name

Example:

"Pacific Time"

jobSpecification.{key}.dropoffLocation.addressNumber

string | null

Address number

Example:

"1600"

jobSpecification.{key}.dropoffLocation.addressFormattedStreet

string | null

Address formatted street

Example:

"Amphitheatre Parkway"

jobSpecification.{key}.dropoffLocation.addressCounty

string | null

Address county

Example:

"Santa Clara"

jobSpecification.{key}.dropoffLocation.addressState

string | null

Address state

Example:

"CA"

jobSpecification.{key}.dropoffLocation.addressZip

string | null

Address zip

Example:

"94043"

jobSpecification.{key}.dropoffLocation.instructions

string | null

Instructions

Example:

"Turn left on Main St"

jobSpecification.{key}.dropoffLocation.businessName

string | null

Business name

Example:

"Nash"

jobSpecification.{key}.dropoffLocation.firstName

string | null

First name

Example:

"John"

jobSpecification.{key}.dropoffLocation.lastName

string | null

Last name

Example:

"Doe"

jobSpecification.{key}.dropoffLocation.phoneNumber

string | null

Phone number

Example:

"+15555555555"

jobSpecification.{key}.dropoffLocation.email

string | null

Example:

"[email protected]"

jobSpecification.{key}.dropoffLocation.lat

number | null

Latitude

Example:

37.774929

jobSpecification.{key}.dropoffLocation.lng

number | null

Longitude

Example:

-122.419416

jobSpecification.{key}.description

string | null

Description

Example:

"Package description"

jobSpecification.{key}.tags

string[] | null

Tags

Example:

["Alcohol"]

jobSpecification.{key}.packageDeliveryMode

string | null

Package delivery mode

Example:

"now"

jobSpecification.{key}.pickupStartTime

string | null

Pickup start time

Example:

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

jobSpecification.{key}.pickupEndTime

string | null

Pickup end time

Example:

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

jobSpecification.{key}.pickupBarcodes

string[] | null

jobSpecification.{key}.dropoffStartTime

string | null

Dropoff start time

Example:

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

jobSpecification.{key}.dropoffEndTime

string | null

Dropoff end time

Example:

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

jobSpecification.{key}.dropoffBarcodes

string[] | null

jobSpecification.{key}.taxCents

integer | null

Tax in cents

Example:

100

jobSpecification.{key}.serviceFeeCents

integer | null

Service fee in cents

Example:

100

jobSpecification.{key}.externalIdentifier

string | null

External identifier

Example:

"mini-mart-order-99"

jobSpecification.{key}.minimumVehicleSize

enum<string>

Available options:

any,

bike,

motorbike,

cargobike,

sedan,

car,

suv,

pickup_truck,

pickup,

van,

large_van,

extra_large_van,

truck

Example:

"car"

jobSpecification.{key}.pickupStoreLocationId

string | null

Pickup store location ID

Example:

"store_01234567890"

jobSpecification.{key}.pickupStoreLocationExternalId

string | null

Pickup store location external ID

Example:

"0123"

jobSpecification.{key}.dropoffStoreLocationId

string | null

Dropoff store location ID

Example:

"store_01234567890"

jobSpecification.{key}.drivingMetrics

Drivingmetrics · object

Driving metrics (distance in meters, duration in seconds)

Example:

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

jobSpecification.{key}.value

number | null

Value

Example:

100

jobSpecification.{key}.tax

Tax

Example:

100

jobSpecification.{key}.serviceFee

Service fee

Example:

100

jobSpecification.{key}.tipAmountCents

integer | null

jobSpecification.{key}.weight

Weight

Example:

100

jobSpecification.{key}.dimensions

Dimensions · object

Dimensions

Example:

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

jobSpecification.{key}.items

ItemOutput · object[] | null

Items

Show child attributes

jobSpecification.{key}.items.id

string | null

The merchant ID of the item

Example:

"abc-123"

jobSpecification.{key}.items.description

string | null

The description of the item

Example:

"A box of books"

jobSpecification.{key}.items.count

integer

default:1

The quantity of the item

Example:

2

jobSpecification.{key}.items.dimensions

Dimensions · object

The dimensions of the item

Show child attributes

jobSpecification.{key}.items.dimensions.height

The height of the item in centimeters (cm)

Example:

10

jobSpecification.{key}.items.dimensions.width

The width of the item in centimeters (cm)

Example:

12

jobSpecification.{key}.items.dimensions.depth

The depth of the item in centimeters (cm)

Example:

14

Example:

{ "depth": 14, "height": 10, "width": 12 }

jobSpecification.{key}.items.weight

The weight of the item in kilograms (kg)

Example:

1.5

jobSpecification.{key}.items.valueCents

integer | null

The value of the item in cents

Example:

1000

jobSpecification.{key}.items.subItems

SubItemOutput · object[] | null

The nested sub-items

Show child attributes

jobSpecification.{key}.items.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

jobSpecification.{key}.items.subItems.description

string | null

The description of the item

Example:

"A box of books"

jobSpecification.{key}.items.subItems.count

integer

default:1

The quantity of the item

Example:

2

jobSpecification.{key}.items.subItems.dimensions

Dimensions · object

The dimensions of the item

Show child attributes

jobSpecification.{key}.items.subItems.dimensions.height

The height of the item in centimeters (cm)

Example:

10

jobSpecification.{key}.items.subItems.dimensions.width

The width of the item in centimeters (cm)

Example:

12

jobSpecification.{key}.items.subItems.dimensions.depth

The depth of the item in centimeters (cm)

Example:

14

Example:

{ "depth": 14, "height": 10, "width": 12 }

jobSpecification.{key}.items.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

jobSpecification.{key}.items.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

jobSpecification.{key}.items.subItems.sku

string | null

The SKU of the sub-item

jobSpecification.{key}.items.subItems.substitution

SubstitutionObject · object

Substitution information for the sub-item

Show child attributes

jobSpecification.{key}.items.subItems.substitution.preference

string | null

Substitution preference: refund or substitute

jobSpecification.{key}.items.subItems.substitution.source

string | null

Source of substitution, e.g., merchant, customer

jobSpecification.{key}.items.subItems.substitution.substituteItems

SubstituteItemObject · object[] | null

List of substitute items

Show child attributes

jobSpecification.{key}.items.subItems.substitution.substituteItems.id

string | null

The ID of the substitute item

jobSpecification.{key}.items.subItems.substitution.substituteItems.sku

string | null

The SKU of the substitute item

jobSpecification.{key}.items.subItems.substitution.substituteItems.quantity

integer | null

The quantity of the substitute item

jobSpecification.{key}.items.subItems.subItems

any | null

The nested sub-items

Example:

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

jobSpecification.{key}.referenceId

string | null

Reference ID

Example:

"mini-mart-order-99"

jobSpecification.{key}.packageMetadata

Packagemetadata · object

Package metadata

Example:

{ "key": "value" }

Example:

{ "packages": [] }

route

RouteSerializer · object

Route

Show child attributes

route.id

string

required

Unique identifier for the route.

Example:

"rte_JphRWDiEosGpXuxwgaYfY3"

route.type

string

required

Type of the route, indicating the pickup/dropoff structure.

Example:

"SINGLE_PICKUP_MULTIPLE_DROPOFFS"

route.stops

RouteStopSerializer · object[]

required

Ordered list of stops included in the route.

Show child attributes

route.stops.stopType

string

required

Type of the stop.

Example:

"PICKUP"

route.stops.objectIds

string[]

required

List of object IDs (e.g., order IDs, store location IDs) associated with this stop.

Example:

[
  "ord_Qr5bVt8WiByGh66z2g7xEu",
  "ord_WJFuooSiRvFCaceGZjpbqs"
]

route.stops.location

RouteStopLocationSerializer · object

required

Geographic location of the stop. Can be null for non-location based stops like breaks.

Show child attributes

route.stops.location.lat

number

required

Latitude coordinate.

Example:

45.558214

route.stops.location.lng

number

required

Longitude coordinate.

Example:

-122.587074

route.stops.arrivalTime

string | null

Estimated arrival time at the stop (UTC).

Example:

"2025-04-25T03:27:00"

route.stops.departTime

string | null

Estimated departure time from the stop (UTC).

Example:

"2025-04-25T03:30:00"

route.stops.serviceTime

number | null

Estimated service time spent at the stop (in seconds).

Example:

360

route.stops.distanceFromPrevious

number | null

Distance traveled from the previous stop (in meters).

Example:

3376

route.stops.durationFromPrevious

number | null

Travel duration from the previous stop (in seconds).

Example:

420

route.jobId

string | null

required

Dispatched Job ID of this route

Example:

"job_1234567890abcdef12345678"

route.externalId

string | null

External Route ID.

Example:

"rte_JphRWDiEosGpXuxwgaYfY3"

route.routeMetadata

Routemetadata · object

Additional metadata for the route.

Example:

{
  "priority": "high",
  "source": "optimization_engine"
}

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Routes

Shifts

Templates

Store Catalog

Miscellaneous

Scheduled Job Time Calculations

Package Items

Authorizations

Body

Response

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Routes

Shifts

Templates

Store Catalog

Miscellaneous

​Scheduled Job Time Calculations

​Package Items

Authorizations

Body

Response

Scheduled Job Time Calculations

Package Items