API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- PATCHUpdate order
- GETGet order
- POSTCreate Quote
- GETGet Order Documents
- POSTSelect Quote
- POSTRefresh order quotes
- POSTAutodispatch Order
- POSTAdd Custom Event to Order
- DELArchive order
- Bulk Order Actions
- Delivery Windows & Capacity
Dispatch Strategies
Notifications
Store Locations
Delivery Windows & Capacity
Jobs
- Background
- Package Requirements
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTRefresh Quotes
- POSTAutodispatch Job
- POSTAutodispatch Job by External Identifier
- POSTCancel Job
- POSTCancel Job by External Identifier
- POSTCreate Delivery Incident
Batch Jobs
Providers
Miscellaneous
Cancel Job by External Identifier
Cancels a Nash Job by the Partner’s External ID if one was supplied at job creation.
Path Parameters
job external identifier
Response
Expected output from autodispatch job endpoint.
A Nash Job.
Created at
Job ID
Is the job active
Is the job a batch
Job configurations
Job Configuration ID
Package
Generic serializer for location used in many endpoints.
Address
Address city
Address country
Formatted address
Location ID
Phone number
Timezone ID
Timezone name
Address county
Address formatted street
Address number
Address state
Address zip
Business name
First name
Instructions
Last name
Package ID
Items count
Generic serializer for location used in many endpoints.
Address
Address city
Address country
Formatted address
Location ID
Phone number
Timezone ID
Timezone name
Address county
Address formatted street
Address number
Address state
Address zip
Business name
First name
Instructions
Last name
Requirements
Description
Dimensions
Driving metrics (distance in meters, duration in seconds)
Dropoff end time
Dropoff start time
Dropoff store location ID
External identifier
Items
Minimum vehicle size
Package delivery mode
Package metadata
Pickup end time
Pickup start time
Pickup store location ID
Reference ID
Service fee
Service fee in cents
Tags
Tax
Tax in cents
Value
Weight
Tasks
Created at
Task ID
Status
Delivery object
Currency
Delivery ID
Is the delivery active
Price in cents
Delivery status
Cancellation fee in cents
Courier dropoff phone number
Courier location
Courier name
Courier phone number
Courier pickup phone number
Courier profile image
Courier vehicle
Documents
Dropoff deadline
Dropoff ETA
Insurance fee in cents
Nash fee in cents
Other provider fees
Pickup ETA
Price
Proof of delivery
Provider batch id
Provider delivery id
Return fee in cents
Delivery status history
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Wait fee in cents
Wait time in minutes
Dropoff end time
Dropoff start time
Failed quotes
Failure reason
Pickup end time
Pickup start time
Provider ID
Provider is internal
Quotes
Created time
Quote ID
Price in cents
Provider ID
Provider name
Cost split business in cents
Cost split customer in cents
Currency
Dropoff ETA
Error message
Expire time
Insurance fee in cents
Is successful
Nash fee in cents
Pickup window
Price
Is the provider internal
Provider logo
Tags
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Quote type
Tip amount in cents
Tip amount in USD
Winner quote
Advanced task
Created at
Task ID
Status
Delivery object
Currency
Delivery ID
Is the delivery active
Price in cents
Delivery status
Cancellation fee in cents
Courier dropoff phone number
Courier location
Courier name
Courier phone number
Courier pickup phone number
Courier profile image
Courier vehicle
Documents
Dropoff deadline
Dropoff ETA
Insurance fee in cents
Nash fee in cents
Other provider fees
Pickup ETA
Price
Proof of delivery
Provider batch id
Provider delivery id
Return fee in cents
Delivery status history
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Wait fee in cents
Wait time in minutes
Dropoff end time
Dropoff start time
Failed quotes
Failure reason
Pickup end time
Pickup start time
Provider ID
Provider is internal
Quotes
Created time
Quote ID
Price in cents
Provider ID
Provider name
Cost split business in cents
Cost split customer in cents
Currency
Dropoff ETA
Error message
Expire time
Insurance fee in cents
Is successful
Nash fee in cents
Pickup window
Price
Is the provider internal
Provider logo
Tags
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Quote type
Task notes
Tip amount in cents
Tip amount in USD
Winner quote
Delivery
Currency
Delivery ID
Is the delivery active
Price in cents
Delivery status
Cancellation fee in cents
Courier dropoff phone number
Courier location
Courier name
Courier phone number
Courier pickup phone number
Courier profile image
Courier vehicle
Documents
Dropoff deadline
Dropoff ETA
Insurance fee in cents
Nash fee in cents
Other provider fees
Pickup ETA
Price
Proof of delivery
Provider batch id
Provider delivery id
Return fee in cents
Delivery status history
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Wait fee in cents
Wait time in minutes
Public tracking URL
Portal URL
External identifier
Job metadata
Job specification
Generic serializer for location used in many endpoints.
Address
Address city
Address country
Formatted address
Location ID
Phone number
Timezone ID
Timezone name
Address county
Address formatted street
Address number
Address state
Address zip
Business name
First name
Instructions
Last name
Package ID
Items count
Generic serializer for location used in many endpoints.
Address
Address city
Address country
Formatted address
Location ID
Phone number
Timezone ID
Timezone name
Address county
Address formatted street
Address number
Address state
Address zip
Business name
First name
Instructions
Last name
Requirements
Description
Dimensions
Driving metrics (distance in meters, duration in seconds)
Dropoff end time
Dropoff start time
Dropoff store location ID
External identifier
Items
Minimum vehicle size
Package delivery mode
Package metadata
Pickup end time
Pickup start time
Pickup store location ID
Reference ID
Service fee
Service fee in cents
Tags
Tax
Tax in cents
Value
Weight
Options group
Dispatch Strategy ID
Dispatch Strategy Label
Allowed providers
Cost split max fixed price in cents
Cost split max percentage
Cost split strategy
Enable auto dispatch
Enable max delivery fee
Max delivery fee in cents
Provider selection strategy
Reassign on failure
Selected configuration
Created at
Task ID
Status
Delivery object
Currency
Delivery ID
Is the delivery active
Price in cents
Delivery status
Cancellation fee in cents
Courier dropoff phone number
Courier location
Courier name
Courier phone number
Courier pickup phone number
Courier profile image
Courier vehicle
Documents
Dropoff deadline
Dropoff ETA
Insurance fee in cents
Nash fee in cents
Other provider fees
Pickup ETA
Price
Proof of delivery
Provider batch id
Provider delivery id
Return fee in cents
Delivery status history
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Wait fee in cents
Wait time in minutes
Dropoff end time
Dropoff start time
Failed quotes
Failure reason
Pickup end time
Pickup start time
Provider ID
Provider is internal
Quotes
Created time
Quote ID
Price in cents
Provider ID
Provider name
Cost split business in cents
Cost split customer in cents
Currency
Dropoff ETA
Error message
Expire time
Insurance fee in cents
Is successful
Nash fee in cents
Pickup window
Price
Is the provider internal
Provider logo
Tags
Tax amount in cents
Toll fee in cents
Total price breakdown
Total price in cents
Quote type
Tip amount in cents
Tip amount in USD
Winner quote
7-digit non-unique human-readable reference code for the job.