Nash

API Reference

Integration Examples

Changelog

Portal

Support

This endpoint allows you to get all available providers in your organization.

Get Providers

Logo

Name

Providerid

OrgProviderPayload

Expected output when listing org providers, it will return an array of this.

ListOrgProvidersOutputSerializer

Get providers

The Most Reliable Way to Organize and Manage Delivery

Welcome to Nash

A brief introduction to Nash and how it can help your business.

What is Nash?

Nash is a powerful delivery orchestration platform designed for businesses to streamline their delivery operations, reduce costs, and expand their reach.

What Nash Offers

Plan Your Integration

How to retrieve an API Key and Organization ID from the Nash portal

API Key and Org ID

Nash API Overview

Glossary

Environments

Authentication

Errors

Webhooks

Delivery Status

Nash's APIs use rate-limiting mechanisms to control the number of requests an organization can make to the API.

Rate-Limits & Request Throttling

API Tutorial Example Workflow - Nom Nom Goods

Sample Checkout Workflow

Production Testing

Overview

Nash API is the gateway to our delivery orchestration platform.

Nash API

Overview of Nash Orders (and their relation to Jobs)

Background

Order Address Validation (Geocoding)

Create Order

Create Orders

Create or update order by external identifier

Update order

Get order

Create Quote

Get Order Documents

Select the quote you would like to execute from a specific order.

Select Quote

Refresh order quotes

Automatically select a quote based on the order's dispatch stategy.

Autodispatch Order

Adds a customizable event to an existing Nash order. Custom order events will be shown in the order events page alongside other Nash-generated events.

Add Custom Event to Order

Archive order

Create, update, upsert, or delete orders asynchronously in bulk.

Bulk Order Actions

Get the response from an asynchronous bulk order operation.

Get Bulk Order Response

Book Delivery Window Slot

Confirm a delivery window slot for order.

Confirm Delivery Window Slot

Revoke Delivery Window Slot

Dispatch Strategies

Automations

List your organization's dispatch strategies.

Get Dispatch Strategies

Create dispatch strategy

Update dispatch strategy

Notifications

Adds a contact to the deny list to opt the user out of communications.

Add Contact to the Deny List

Retrieves a list of contacts that have opted out of communications.

Get Contacts in the Deny List

Removes a contact from the deny list to opt the user back into communications.

Remove Contact from the Deny List

Create store location

Update Store Location

Get Store Location

Get Store Locations

Get store location by external identifier

Delete store location

Get store locations that cover specified latitude and longitude

Get a Delivery Window Slot

Package Requirements

Create Job

Create or Update Job by External Identifier

Update Job

Get Job

Retrieve a job by its external identifier.

Get Job by External Identifier

Select the quote you would like to execute from a specific job.

Regenerate quotes for a given job's task.

Refresh Quotes

Automatically select a quote based on dispatch strategy

Autodispatch Job

Autodispatch Job by External Identifier

Cancel Job

Cancels a Nash Job by the Partner's External ID if one was supplied at job creation.

Cancel Job by External Identifier

Create a new delivery incident for a task

Create Delivery Incident

Create Batch Job

This endpoint allows you to update some fields in the Nash job. Updating a job should always work before a quote is selected, but if a quote has been selected, Nash will return an error if the fleet rejects the update of the order.

Update Batch Job

Select Quote (Batch)

Refresh Quotes (Batch)

This endpoint allows you to cancel a batch job by job ID and task or job configuration ID.

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations

Delivery Windows & Capacity

Jobs

Batch Jobs

Providers

Miscellaneous

Get Providers

Response