# Nash

> ## Agent Instructions
> Nash exposes two MCP servers. The docs MCP server at https://docs.usenash.com/mcp searches this documentation and needs no credentials. The Nash MCP server at https://mcp.usenash.com/mcp operates an organization's deliveries and needs a Nash API key. See https://docs.usenash.com/reference/build-with-ai.
> Use the Sandbox environment (https://api.sandbox.usenash.com/v1) for anything that creates or dispatches deliveries during development.

- [How Nash works](https://docs.usenash.com/reference/how-nash-works.md): A complete overview of the Nash delivery orchestration platform — the delivery lifecycle, the provider network, and the core building blocks you integrate with.
- [Plan your integration](https://docs.usenash.com/reference/plan-your-integration.md): How to plan a Nash API integration: timeline, account setup, dispatch strategies, notifications, and go-live.
- [API key and Org ID](https://docs.usenash.com/reference/generating-api-key-and-org-id.md): Create an API key in the Nash Portal and find the Organization ID to send with your requests.
- [Authentication](https://docs.usenash.com/reference/authentication.md): Authenticate Nash API requests with a Bearer API key and the Nash-Org-Id header.
- [Single sign-on](https://docs.usenash.com/reference/single-sign-on.md): Nash Portal sign-in can be connected to your own identity provider over OpenID Connect or SAML 2.0.
- [Roles and access](https://docs.usenash.com/reference/roles-and-access.md): How Nash roles and feature permissions work, recommended user groups to start from, and how to keep configuration and credentials restricted.
- [Environments](https://docs.usenash.com/reference/environments.md): Base URLs and Portal links for the Nash Production and Sandbox environments, and how Sandbox differs from Production.
- [Production testing](https://docs.usenash.com/guides/production-testing.md): How to schedule an integration testing call with Nash and get production API keys enabled.
- [Orders, jobs & dispatch](https://docs.usenash.com/reference/nash-api-overview.md): The key concepts behind the Nash API: orders, jobs, quoting, and dispatch.
- [Dispatch strategies](https://docs.usenash.com/reference/dispatch-strategies.md): How dispatch strategies control which providers can fulfill a job, how Nash selects one, what it can cost, when it dispatches, and how it recovers.
- [Delivery status](https://docs.usenash.com/reference/delivery-status.md): The normalized delivery statuses Nash reports across all providers, including terminal statuses and the guaranteed status order.
- [Delivery fees and pricing](https://docs.usenash.com/reference/delivery-fees-and-pricing.md): What a quote's price includes, which fees land on a delivery, how totalPriceCents is computed, and when each fee is final.
- [Delivery windows](https://docs.usenash.com/reference/delivery-windows.md): A delivery window is a bookable time slot, tied to a store location and bounded by capacity, that an order can be scheduled into.
- [Routes](https://docs.usenash.com/reference/routes.md): A route is a planned, ordered sequence of stops for a vehicle or driver. Learn how to create, update, and dispatch routes — and how routes relate to route optimization.
- [Zones](https://docs.usenash.com/reference/zones.md): A zone is a geographic delivery area defined by a polygon boundary or a list of cities, zip codes, states, or countries. Learn how zones model coverage, how to look up which zones cover a location, and how zones relate to store locations.
- [Store locations](https://docs.usenash.com/reference/store-locations.md): A store location is a physical origin — a restaurant, warehouse, or store — that deliveries depart from. Learn how to model store locations, upsert them by your own identifier, and look up which stores cover a location.
- [Store catalog](https://docs.usenash.com/reference/store-catalog.md): The store catalog combines a master product catalog and per-store inventory to power item-level fulfillment. Learn how products and inventory fit together, how Pick and Pack works, and what item-level details an order can carry.
- [Webhooks](https://docs.usenash.com/reference/webhooks.md): Set up and consume Nash webhooks: event types, payload shape, signature verification, and retries.
- [Shift dispatched event](https://docs.usenash.com/reference/shift-dispatched-event.md): The shift.dispatched webhook fires when orders from a delivery window (shift) are dispatched in bulk to delivery jobs. Payload structure, scenarios, and error reference.
- [Workflows](https://docs.usenash.com/reference/workflows.md): Nash workflows are an automation engine that responds to delivery events with filters and actions — applying dispatch strategies, modifying orders, sending notifications, and more.
- [Notifications](https://docs.usenash.com/reference/notifications.md): Nash's built-in notifications platform alerts customers and internal teams on delivery events across SMS, email, WhatsApp, Slack, and webhook — with reusable audiences, fine-grained targeting, and customizable messages.
- [Refunds & incidents](https://docs.usenash.com/reference/refunds-and-incidents.md): Report a delivery incident, optionally request a refund, and track the refund request through review.
- [Display preferences](https://docs.usenash.com/reference/display-preferences.md): How the Portal decides which language, timezone, formats, and units to show you, and how to override your organization's defaults for yourself.
- [Sample checkout workflow](https://docs.usenash.com/guides/checkout-workflow.md): A step-by-step workflow for embedding Nash delivery quotes, dispatch, and tracking into your checkout.
- [Fast casual restaurant integration](https://docs.usenash.com/guides/fast-casual-restaurant-integration.md): Quote delivery during checkout, dispatch when payment succeeds, and track every delivery through webhooks.
- [Route optimization](https://docs.usenash.com/guides/route-optimization.md): Submit optimization requests, poll for results, and dispatch optimized routes using the Nash API.
- [Find and act on a list of orders](https://docs.usenash.com/guides/find-and-act-on-orders.md): Paste a list of Nash IDs, external IDs, or reference IDs into the Portal's Orders table, see every match, and dispatch, mark as picked up, archive, or unarchive the orders each action applies to.
- [API tutorial: an example checkout workflow with Nom Nom Goods](https://docs.usenash.com/guides/api-tutorial-workflow-nom-nom-foods.md): A basic Nash integration through an example app checkout workflow.
- [Embed the Nash live-tracking experience](https://docs.usenash.com/reference/nash-embedding.md): Embed Nash's hosted live-tracking page in your web or mobile app with an iframe.
- [Build with AI](https://docs.usenash.com/reference/build-with-ai.md): Every way to put an AI assistant or agent to work on your Nash integration — the docs MCP server, machine-readable references, and the Nash MCP server.
- [Docs MCP server](https://docs.usenash.com/reference/docs-mcp-server.md): Connect Claude, Cursor, VS Code, or any MCP client to the Nash documentation so your AI assistant answers integration questions from the current docs.
- [Nash MCP server](https://docs.usenash.com/reference/mcp-integration.md): Give your AI agent direct access to Nash deliveries through our Model Context Protocol (MCP) server.
- [Overview](https://docs.usenash.com/fleet/overview.md): Manage drivers and fulfill Nash deliveries with your own fleet: how driver setup, dispatch, delivery-state updates, and the Fleet API fit together.
- [Set up your internal fleet](https://docs.usenash.com/guides/internal-fleet-setup.md): An admin guide to configuring an internal fleet, adding drivers, and enabling live location tracking in the Nash Portal.
- [Report delivery state](https://docs.usenash.com/fleet/report-delivery-state.md): How a fleet reports status, location, proof of delivery, and ETAs back to Nash as a job (delivery) progresses — for single and bulk updates, and how to test transitions with Fleet simulators.
- [Glossary](https://docs.usenash.com/reference/glossary.md): Definitions of the core Nash concepts you'll meet across the docs and API.
- [API errors](https://docs.usenash.com/reference/errors.md): How to read Nash API errors, handle retries, and interpret the error codes returned most often.
- [Rate limits & throttling](https://docs.usenash.com/reference/rate-limits-throttling.md): Nash allows 20 requests per second per organization. How 429 responses work and how to back off.
- [Nash Agent](https://docs.usenash.com/nash-agent/overview.md): Nash Agent answers questions about your deliveries, investigates problems, and takes action — pausing for your approval on sensitive steps — all scoped to your organization and your permissions.
- [Guardrails & confirmations](https://docs.usenash.com/nash-agent/guardrails.md): How Nash Agent decides which actions run automatically and which require your approval.
- [Channels: Slack, SMS & voice](https://docs.usenash.com/nash-agent/channels.md): Work with Nash from Slack, and let Nash reach a customer or driver by text or voice call on your behalf — always with your sign-off.
- [Knowledge](https://docs.usenash.com/nash-agent/knowledge.md): Give the agent your reference material — SOPs, policies, and links — so it answers in your operation's context.
- [Memory & learning](https://docs.usenash.com/nash-agent/memory-and-learning.md): Let Nash automatically remember how your team works and pick up useful context over time — an opt-in, org-controlled capability.
- [How Nash gets to know how you work](https://docs.usenash.com/nash-agent/how-nash-learns-about-your-team.md): A closer look at the working-style profile behind Memory and learning — what the agent quietly picks up about you, and what you can shape by hand.
- [Custom agents](https://docs.usenash.com/nash-agent/custom-agents.md): Configure a scoped, instruction-driven Nash agent for a recurring job, then run it on demand or on a schedule.
- [Custom agent configuration reference](https://docs.usenash.com/nash-agent/custom-agent-configuration.md): A field-by-field reference for everything you can set on a custom agent — identity, scope, behavior, skills, knowledge, output, and limits.
- [Chat with a custom agent](https://docs.usenash.com/nash-agent/chat-with-a-custom-agent.md): Open a live conversation with one of your custom agents — it answers and works under its own instructions, scope, and execution mode.
- [Embedded chat](https://docs.usenash.com/nash-agent/embedded-chat.md): Put one of your custom agents in your own product as a chat widget, so your customers can ask about their delivery without contacting support.
- [Scheduling & execution](https://docs.usenash.com/nash-agent/scheduling-and-execution.md): Control how and when a custom agent runs — on a schedule, when something happens, or on demand — and whether it reports or acts.
- [Skills](https://docs.usenash.com/nash-agent/skills.md): Reusable, named playbooks that teach the agent how to handle a specific situation — and that you can hand to a custom agent.
- [Improvements](https://docs.usenash.com/nash-agent/improvements.md): Set a multi-day goal and let Nash work toward it — analyzing your operation on a cadence and proposing actions you approve or reject.
- [Entity monitor](https://docs.usenash.com/nash-agent/entity-monitor.md): Have an agent keep watch on a single delivery, order, route, return, or job and surface risks until it's resolved.
- [Daily Brief](https://docs.usenash.com/nash-agent/daily-brief.md): A morning read of what your agents found — curated insights with evidence you can verify, and the decisions waiting on you.
- [External connectors](https://docs.usenash.com/nash-agent/connectors.md): Connect external systems to Nash so your agents can use them as tools — from prebuilt integrations to your own APIs.
- [Nash API](https://docs.usenash.com/api-reference/api-overview.md): The Nash API is the gateway to the delivery orchestration platform. Find the right resource group, learn how to authenticate, pick an environment, and get started.
- [Using LLMs with Nash API](https://docs.usenash.com/api-reference/using-llms-with-nash-api.md): Point an LLM at the Nash API reference and let it speed up your integration
- [Orders overview](https://docs.usenash.com/api-reference/order/order.md): What an order is, how to choose an order creation flow, and how orders relate to jobs (deliveries).
- [Order address validation (geocoding)](https://docs.usenash.com/api-reference/order/order-address-validation-geocoding.md): How Nash validates addresses, and how to bring your own address components instead.
- [Order requirements](https://docs.usenash.com/api-reference/order/order-requirements.md): Requirements you can attach to a Nash order, such as proof of delivery, age verification, and barcode scans.
- [Order validations](https://docs.usenash.com/api-reference/order/order-validations.md): The validations Nash applies when you create an order, covering addresses, required fields, data formats, enums, and datetimes.
- [Create Order](https://docs.usenash.com/api-reference/order/create-order.md): Create an order in Nash
- [Create Orders](https://docs.usenash.com/api-reference/order/create-orders.md): Create multiple pre-dispatch orders in a single request. Each order is created independently with its own pickup and dropoff details.
- [Create or Update Order by External Identifier](https://docs.usenash.com/api-reference/order/create-or-update-order-by-external-identifier.md): Create an order or update an existing one, keyed by your own external identifier.
- [Create or Update Orders by External Identifier](https://docs.usenash.com/api-reference/order/create-or-update-orders-by-external-identifier-v2.md): Create or update multiple orders by external identifier in Nash
- [Update order](https://docs.usenash.com/api-reference/order/update-order.md): Update an existing pre-dispatch order's details such as addresses, times, or metadata. Only provided fields are updated.
- [Get order](https://docs.usenash.com/api-reference/order/get-order.md): Retrieve a single order by ID, including its pickup/dropoff details, status, and metadata.
- [List/Search Orders](https://docs.usenash.com/api-reference/order/listsearch-orders.md): List orders with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/order/<id> for full details.
- [Create Quote](https://docs.usenash.com/api-reference/order/get-order-quotes.md): Create a new quote for an order
- [Get Order Documents](https://docs.usenash.com/api-reference/order/get-order-documents.md): Get the documents for an order
- [Select Quote](https://docs.usenash.com/api-reference/order/select-quote.md): Select the quote you would like to execute from a specific order.
- [Refresh order quotes](https://docs.usenash.com/api-reference/order/refresh-order-quotes.md): Request fresh price quotes from delivery providers for an existing order. Replaces any existing quotes with updated pricing from available providers.
- [Autodispatch Order](https://docs.usenash.com/api-reference/order/autodispatch-order.md): Automatically select a quote based on the order's dispatch strategy.
- [Add Custom Event to Order](https://docs.usenash.com/api-reference/order/add-custom-event-to-order.md): 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.
- [Archive order](https://docs.usenash.com/api-reference/order/archive-order.md): Archive (soft-delete) an order. Archived orders are hidden from default listings but can be restored using the unarchive endpoint.
- [Confirm order](https://docs.usenash.com/api-reference/order/confirm-order.md): Confirm a valid order, changing its status from 'valid' to 'confirmed'.
- [Unarchive order](https://docs.usenash.com/api-reference/order/unarchive-order.md): Restore a previously archived order, making it visible in default listings again.
- [Undispatch an order](https://docs.usenash.com/api-reference/order/undispatch-an-order.md): Un-dispatch a route-based order: cancel its active task and provider delivery, remove it from its route (re-syncing the linked batch), and revert it to the `valid` status. Returns the updated order. Errors if the order is not dispatched, or is not associated with a route.
- [Undispatch an order by id](https://docs.usenash.com/api-reference/order/undispatch-an-order-by-id.md): Un-dispatch a route-based order by id: cancel its active task and provider delivery, remove it from its route (re-syncing the linked batch), and revert it to the `valid` status. Returns the updated order. Errors if the order is not dispatched, or is not associated with a route.
- [Bulk Order Actions](https://docs.usenash.com/api-reference/order/create-update-upsert-or-delete-orders-asynchronously-in-bulk.md): Create, update, upsert, or delete orders asynchronously in bulk.
- [Get Bulk Order Response](https://docs.usenash.com/api-reference/order/get-response-from-asynchronous-bulk-order-operation.md): Get the response from an asynchronous bulk order operation.
- [Upsert order by external identifier with delivery window](https://docs.usenash.com/api-reference/order/upsert-order-by-external-identifier-with-delivery-window.md): Create or update an order by external identifier and associate it with a delivery window. The order is linked to the specified delivery window for scheduled delivery.
- [Get eligible delivery windows for order](https://docs.usenash.com/api-reference/delivery-windows/get-eligible-delivery-windows-for-order.md): Find delivery windows available for a specific order based on the order's store location and requirements. Requires either order_id or external_order_id. Optionally filter by time range and requested capacity.
- [Book a delivery window for order](https://docs.usenash.com/api-reference/delivery-windows/book-a-delivery-window-for-order.md): Reserve a delivery window for an order identified by external ID. The booking holds capacity in the window until confirmed or revoked.
- [Confirm a delivery window for order](https://docs.usenash.com/api-reference/delivery-windows/confirm-a-delivery-window-for-order.md): Confirm a previously booked delivery window for an order. Finalizes the booking and commits the capacity reservation.
- [Revoke a delivery window for order](https://docs.usenash.com/api-reference/delivery-windows/revoke-a-delivery-window-for-order.md): Revoke a previously booked delivery window for an order. Releases the capacity reservation and disassociates the window from the order.
- [Create a single delivery window](https://docs.usenash.com/api-reference/delivery-windows/create-a-single-delivery-window.md): Create a delivery window defining an available time slot for scheduled deliveries. Delivery windows are associated with a store location and have capacity limits.
- [Get a delivery window](https://docs.usenash.com/api-reference/delivery-windows/get-a-delivery-window.md): Retrieve a single delivery window by ID, including its time slot, capacity, and status.
- [Dispatch strategies](https://docs.usenash.com/api-reference/dispatch-strategies/dispatch-strategy.md): How dispatch strategies (options groups) control which providers can fulfill a job and how a provider is selected.
- [Automations](https://docs.usenash.com/api-reference/dispatch-strategies/dispatch-automations.md): Apply dispatch strategies dynamically with rule-based automations evaluated against each incoming job.
- [Get Dispatch Strategies](https://docs.usenash.com/api-reference/dispatch-strategies/get-dispatch-strategies.md): List your organization's dispatch strategies.
- [Create dispatch strategy](https://docs.usenash.com/api-reference/dispatch-strategies/create-dispatch-strategy.md): Create a new dispatch strategy (options group) with provider selection rules, fallback logic, and quoting configuration.
- [Update dispatch strategy](https://docs.usenash.com/api-reference/dispatch-strategies/update-dispatch-strategy.md): Update an existing dispatch strategy's provider selection rules, fallback logic, or quoting configuration. Only provided fields are updated.
- [List Workflows](https://docs.usenash.com/api-reference/workflow/list-workflows.md): Returns all non-archived workflows for the authenticated organization.
- [Get Workflow](https://docs.usenash.com/api-reference/workflow/get-workflow.md): Returns a single workflow by ID, including its latest version with nodes, edges, and trigger.
- [Create Workflow](https://docs.usenash.com/api-reference/workflow/create-workflow.md): Create a new workflow with nodes, edges, and a trigger. The workflow is created in draft status by default. Nodes define the actions and filters, edges define the execution flow between nodes, and the trigger defines when the workflow is activated. First fetch GET /workflows/schema for current actio…
- [Update Workflow](https://docs.usenash.com/api-reference/workflow/update-workflow.md): Update an existing workflow. Only provided fields are updated. If nodes, edges, and trigger are all provided, a new workflow version is created. These three structure fields must be provided together or not at all.
- [Set Workflow Status](https://docs.usenash.com/api-reference/workflow/set-workflow-status.md): Change the status of a workflow (draft, active, inactive, archived, template). Archiving a workflow disables its notification trigger.
- [Trigger Workflow](https://docs.usenash.com/api-reference/workflow/trigger-workflow.md): Trigger an active or inactive workflow with optional entity references and input data. Supports sync and async execution modes.
- [Test Workflow](https://docs.usenash.com/api-reference/workflow/test-workflow.md): Run a workflow against a real entity without activating it. Requires jobId or orderId — the entity the run is evaluated against. By default this is a dry run: filters are evaluated against the entity and each action returns a preview of what it would do, without performing it. With live=true, messag…
- [Get Workflow Schema](https://docs.usenash.com/api-reference/workflow/get-workflow-schema.md): Returns self-describing workflow metadata including triggers, action config schemas, filter operators/fields, published node outputs, and supported workflow node, edge, and status types. Fetch before authoring a workflow. Action-specific edge_rules override the ordinary node-type rules. ai_decision…
- [List Workflow Executions](https://docs.usenash.com/api-reference/workflow-execution/list-workflow-executions.md): Returns paginated workflow execution history with optional filtering by status, date range, and search. Supports sorting by created_at, completed_at, or status.
- [Count Workflow Executions](https://docs.usenash.com/api-reference/workflow-execution/count-workflow-executions.md): Returns the total count of workflow executions matching the given filters. Useful for pagination or dashboards without fetching full execution data.
- [Get Workflow Execution Detail](https://docs.usenash.com/api-reference/workflow-execution/get-workflow-execution-detail.md): Returns a single workflow execution with all its execution steps, including step status, node references, and node variables.
- [Notifications](https://docs.usenash.com/api-reference/notifications/notifications.md): Configure notification triggers, channels, and message variables to keep customers and internal teams informed about deliveries.
- [Get Notification Trigger Catalog](https://docs.usenash.com/api-reference/notifications/get-notification-trigger-catalog.md): The full notification-trigger catalog. Each entry describes a trigger's `type` slug, human `title`, the `value` used to subscribe automations, the `entityType` (route/delivery/task/order/activity), its `statuses` vocabulary, the JSON Schema of its create `parameters`, and the `supportedFilters` / `s…
- [List Notification Trigger Templates](https://docs.usenash.com/api-reference/notifications/list-notification-trigger-templates.md): List pre-defined notification trigger templates. Each template has a `type` slug (e.g. 'tasks_attempts_exhausted') and a human-readable `title` (e.g. 'Tasks Attempts Exhausted'). Use the `type` when creating a trigger via POST /v1/notification-triggers.
- [Add Contact to the Deny List](https://docs.usenash.com/api-reference/notifications/add-a-contact-to-the-deny-list.md): Adds a contact to the deny list to opt the user out of communications.
- [Get Contacts in the Deny List](https://docs.usenash.com/api-reference/notifications/get-contacts-in-the-deny-list.md): Retrieves a list of contacts that have opted out of communications.
- [Remove Contact from the Deny List](https://docs.usenash.com/api-reference/notifications/remove-a-contact-from-the-deny-list.md): Removes a contact from the deny list to opt the user back into communications.
- [Create store location](https://docs.usenash.com/api-reference/store-locations/create-store-location.md): Create a new store location (pickup point) with address, hours, and capacity settings.
- [Update Store Location](https://docs.usenash.com/api-reference/store-locations/update-store-location.md): Update a store location by ID.
- [Create or update store location by external identifier](https://docs.usenash.com/api-reference/store-locations/create-or-update-store-location-by-external-identifier.md): Create a new store location or update an existing one using your external identifier. If a store location with the given external identifier exists, it is updated.
- [Create or update store location](https://docs.usenash.com/api-reference/store-locations/create-or-update-store-location.md): Create a new store location or update an existing one. Matches on external identifier or store location ID for upsert logic.
- [Upsert multiple store locations](https://docs.usenash.com/api-reference/store-locations/upsert-multiple-store-locations.md): Create or update multiple store locations in a single request. Each store location is matched by external identifier for upsert logic.
- [Get Store Location](https://docs.usenash.com/api-reference/store-locations/get-store-location.md): Get a store location by ID.
- [Get Store Locations](https://docs.usenash.com/api-reference/store-locations/get-store-locations.md): Get a list of store locations.
- [Get store location by external identifier](https://docs.usenash.com/api-reference/store-locations/get-store-location-by-external-identifier.md)
- [Delete store location](https://docs.usenash.com/api-reference/store-locations/delete-store-location.md): Delete a store location by ID. Orders referencing this store location will no longer have a valid pickup point.
- [Get store locations that cover specified location (latitude & longitude, city_zipcode)](https://docs.usenash.com/api-reference/store-locations/get-store-locations-that-cover-specified-latitude-and-longitude.md): Find store locations whose delivery zones cover a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching store locations.
- [Create a zone](https://docs.usenash.com/api-reference/zones/create-a-zone.md): Create a geographic zone defined by a polygon boundary. Zones are used to define delivery areas for store locations and apply zone-based restrictions.
- [Update a zone](https://docs.usenash.com/api-reference/zones/update-a-zone.md): Update an existing zone's name, polygon boundary, or associated store locations. Only provided fields are updated.
- [Delete a zone](https://docs.usenash.com/api-reference/zones/delete-a-zone.md): Delete a zone by ID. Removes the zone and its store location associations.
- [Get zone](https://docs.usenash.com/api-reference/zones/get-zone.md): Retrieve a single zone by ID, including its polygon boundary and associated store locations.
- [Get zones](https://docs.usenash.com/api-reference/zones/get-zones.md): List zones for the organization with pagination. Use size and offset parameters to paginate. Optionally include deleted zones with is_deleted.
- [Query zones](https://docs.usenash.com/api-reference/zones/query-zones.md): Return full zone details for many zones in a single call. Filter by `ids` and/or `externalIds` (combined with OR); omit both to page through all of the organization's zones. Results come back under `data` with pagination under `meta`; each `data` item matches the shape of `GET /v1/zones/<id>`.
- [Get zone by external identifier](https://docs.usenash.com/api-reference/zones/get-zone-by-external-identifier.md): Retrieve a zone using your external identifier instead of the Nash zone ID.
- [Get zones that cover specified location (latitude & longitude, city_zipcode)](https://docs.usenash.com/api-reference/zones/get-zones-that-cover-specified-location-latitude-and-longitude-city_zipcode.md): Find zones whose polygon boundaries contain a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching zones.
- [Jobs overview](https://docs.usenash.com/api-reference/job/jobs.md): What a job (delivery) is in Nash, its data model, and the most common paths in the job object.
- [Create Job](https://docs.usenash.com/api-reference/job/create-job.md): Create a new job (delivery)
- [Create or Update Job by External Identifier](https://docs.usenash.com/api-reference/job/create-or-update-job-by-external-identifier.md): Create a new job or update an existing one using your external identifier. If a job with the given external identifier exists, it is updated; otherwise a new job is created. Set autodispatch=true to automatically dispatch after creation.
- [Update Job](https://docs.usenash.com/api-reference/job/update-job-by-id.md): Update fields on a Nash job. Updating a job should always work before a quote is selected; once one has been selected, Nash returns an error if the fleet rejects the change.
- [Update job by job id and job configuration id](https://docs.usenash.com/api-reference/job/update-job-by-job-id-and-job-configuration-id.md)
- [Get Job](https://docs.usenash.com/api-reference/job/get-job.md): Retrieve a job by its ID.
- [Get Job by External Identifier](https://docs.usenash.com/api-reference/job/get-job-by-external-identifier.md): Retrieve a job by its external identifier.
- [List/Search Jobs](https://docs.usenash.com/api-reference/job/listsearch-jobs.md): List jobs (deliveries) with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/jobs/<id> for full details.
- [Select Quote](https://docs.usenash.com/api-reference/job/select-quote.md): Select the quote you would like to execute from a specific job.
- [Reassign a Task](https://docs.usenash.com/api-reference/job/reassign-task-by-job-id-and-task-id.md): Create a new task in a job based on a given job ID and task ID.
- [Refresh Quotes](https://docs.usenash.com/api-reference/job/refresh-quotes-by-job-id-and-task-id.md): Regenerate quotes for a given job's task.
- [Autodispatch Job](https://docs.usenash.com/api-reference/job/autodispatch-job.md): Automatically select a quote based on dispatch strategy
- [Autodispatch Job by External Identifier](https://docs.usenash.com/api-reference/job/autodispatch-job-by-external-identifier.md): Automatically select a quote based on dispatch strategy
- [Cancel Job](https://docs.usenash.com/api-reference/job/cancel-job-by-job-id-and-job-configuration-id.md): Cancel a specific task or job configuration within a batch job. The objectId can be a task ID (tsk_ prefix) or job configuration ID (cfg_ prefix).
- [Cancel Job by External Identifier](https://docs.usenash.com/api-reference/job/cancel-job-by-external-identifier.md): Cancels a Nash Job by the Partner's External ID if one was supplied at job creation.
- [Create Delivery Incident](https://docs.usenash.com/api-reference/job/create-delivery-incident.md): Create a new delivery incident for a task
- [Get Refund Requests](https://docs.usenash.com/api-reference/job/get-refund-requests.md): Retrieve a list of refund requests by task ID or job ID.
- [Get Refund Request](https://docs.usenash.com/api-reference/job/get-refund-request.md): Retrieve a refund request by its ID.
- [Create Batch Job](https://docs.usenash.com/api-reference/batch-job/create-batch-job.md): Create a job with multiple packages
- [Update Batch Job](https://docs.usenash.com/api-reference/batch-job/update-job-by-job-id-and-job-configuration-id.md): Update fields on a Nash job. Updating a job should always work before a quote is selected; once one has been selected, Nash returns an error if the fleet rejects the change.
- [Select Quote (Batch)](https://docs.usenash.com/api-reference/batch-job/select-quote.md): Select the quote you would like to execute from a specific job.
- [Refresh Quotes (Batch)](https://docs.usenash.com/api-reference/batch-job/refresh-quotes-by-job-id-and-batch-id.md): Refresh the quotes for a batch job.
- [Cancel Batch Job](https://docs.usenash.com/api-reference/batch-job/cancel-job-by-job-id-and-task-or-job-configuration-id.md): Cancel a batch job by job ID and task or job configuration ID.
- [Get Providers](https://docs.usenash.com/api-reference/provider/get-providers.md): List all delivery providers configured for your organization, including their status and capabilities.
- [List Routes](https://docs.usenash.com/api-reference/route/list-routes.md): List and search routes with filters and pagination.
- [Get Route](https://docs.usenash.com/api-reference/route/get-route.md): Retrieve a route by ID, including its stops, travel metrics, and associated orders.
- [Create or Update Route](https://docs.usenash.com/api-reference/route/create-or-update-route.md): Create or update a route in Nash
- [Calculate Route Timing](https://docs.usenash.com/api-reference/route/calculate-route-timing.md): Calculate per-stop ETAs and polyline for a route using HERE truck routing. Updates arrival/departure times for each stop and returns the route polyline.
- [Assign or Reassign a Route](https://docs.usenash.com/api-reference/route/assign-route.md): Assign a route to a provider, driver group, courier, or vehicle — before or after dispatch.
- [Find Nearby Couriers](https://docs.usenash.com/api-reference/route/find-nearby-couriers.md): Find the drivers on active routes nearest to a point.
- [Dispatch Routes](https://docs.usenash.com/api-reference/route/dispatch-routes.md): Dispatch one or more routes to delivery providers. Creates jobs for each route and assigns them based on the organization's dispatch strategy.
- [Dispatch Optimized Orders](https://docs.usenash.com/api-reference/route/dispatch-optimized-orders.md): Dispatch orders from an optimization activity to delivery providers. Creates jobs and assigns them to providers based on the optimized routes.
- [Save Optimization Routes](https://docs.usenash.com/api-reference/route/save-optimization-routes.md): Save the optimized routes from an optimization activity. Creates route records with stops and travel metrics based on the optimization results.
- [List Optimization Strategies](https://docs.usenash.com/api-reference/optimization-strategies/list-optimization-strategies.md): Returns all optimization strategies for the authenticated organization (including soft-deleted).
- [Get Optimization Strategy](https://docs.usenash.com/api-reference/optimization-strategies/get-optimization-strategy.md): Returns a single optimization strategy by id.
- [Create Optimization Strategy](https://docs.usenash.com/api-reference/optimization-strategies/create-optimization-strategy.md): Create a new optimization strategy for the authenticated organization. A strategy configures how orders are grouped into routes (service times, pickup-time windows, contracts, store locations, zones, and optional cron schedules).
- [Update Optimization Strategy](https://docs.usenash.com/api-reference/optimization-strategies/update-optimization-strategy.md): Update an existing optimization strategy. Only provided fields are updated. Supplying `optimization_schedules` replaces the existing schedules.
- [Delete Optimization Strategy](https://docs.usenash.com/api-reference/optimization-strategies/delete-optimization-strategy.md): Soft-delete an optimization strategy. Fails if the strategy is referenced by an automation logic or an active automation rule.
- [Create a shift](https://docs.usenash.com/api-reference/shifts/create-a-shift.md): Create a courier shift with start/end times and an assigned store location.
- [Get all shifts](https://docs.usenash.com/api-reference/shifts/get-all-shifts.md): List courier shifts with optional filtering by time range and store location. Filter by start_time, end_time, store_location_id, or external_store_location_id.
- [Get a shift](https://docs.usenash.com/api-reference/shifts/get-a-shift.md): Retrieve a single courier shift by ID, including its times, assigned courier, and store location.
- [Upsert shifts](https://docs.usenash.com/api-reference/shifts/upsert-shifts.md): Create or update multiple courier shifts in a single request. Existing shifts are matched by ID for updates; new shifts are created.
- [Upsert multiple templates](https://docs.usenash.com/api-reference/templates/upsert-multiple-templates.md): Create or update multiple delivery window or shift templates in a single request. Templates generate their instances on a recurring schedule. On update, a shift template's payload is merged: a field you omit keeps its stored value, and clearing one requires sending it explicitly as null. The externa…
- [Pick and Pack overview](https://docs.usenash.com/api-reference/store-catalog/pick-and-pack.md): How Pick and Pack works across orders, the product catalog, and store inventory.
- [Create or update products](https://docs.usenash.com/api-reference/store-catalog/create-or-update-products.md): Create new products or update existing ones in the store catalog. Products are matched by external identifier for upsert logic.
- [Get products](https://docs.usenash.com/api-reference/store-catalog/get-products.md): List products in the store catalog with pagination and optional filtering. Filter by IDs, SKUs, text search, or semantic search.
- [Product catalog examples](https://docs.usenash.com/api-reference/store-catalog/product-catalog-examples.md): Sample product payloads for common product types to help you structure your catalog data correctly.
- [Create or update inventory](https://docs.usenash.com/api-reference/store-catalog/create-or-update-inventory.md): Create or update inventory levels for products at specific store locations. Rows referencing an unknown product or store location are skipped and returned in the same array with `errorCode`/`errorMessage` set; the rest of the batch still commits.
- [Get inventory](https://docs.usenash.com/api-reference/store-catalog/get-inventory.md): List inventory levels with pagination. Filter by external store location ID or external product ID.
- [Sync store inventory catalogs to SFTP](https://docs.usenash.com/api-reference/inventory/sync-store-inventory-catalogs-to-sftp.md): Trigger a full catalog export+upload for all synced stores (`all: true`) or a specific list of store external ids. Returns the run activity id; per-store export runs asynchronously.
- [Add Delivery Feedback](https://docs.usenash.com/api-reference/feedback/add-delivery-feedback.md): Record a customer's rating and comment against a delivery.
- [Add Delivery Feedback by External Identifier](https://docs.usenash.com/api-reference/feedback/add-delivery-feedback-by-external-identifier.md): Record a customer's rating and comment against a delivery, addressed by your own identifier.
- [Manifest Orders](https://docs.usenash.com/api-reference/shipping/manifest-orders.md): Create manifests for dispatched shipping orders. Groups orders by store location and provider, then generates manifest documents (e.g. AusPost order summaries).
- [Dispatch and Manifest Orders](https://docs.usenash.com/api-reference/shipping/dispatch-and-manifest-orders.md): Dispatch a batch of orders and manifest them with the carrier in one call, with per-shipment failures reported rather than the batch refused.
- [Simulate Delivery Status Transition](https://docs.usenash.com/api-reference/fleet-simulator/simulate-delivery-status-transition.md): Advance a delivery to a given status for testing in sandbox.
- [Outbound integration](https://docs.usenash.com/api-reference/fleet/outbound-integration.md): Synchronous HTTP calls Nash makes to a fleet for quoting, dispatch, modifications, cancellations, and refresh.
- [Upsert Driver](https://docs.usenash.com/api-reference/fleet/upsert-driver.md): Create or update a driver in your internal fleet, keyed on your own `externalIdentifier`. There is no separate create vs. update call — sending the same `externalIdentifier` again updates the existing driver. The response's `created` field tells you which happened. To disable a driver, upsert with `…
- [List Driver Groups](https://docs.usenash.com/api-reference/fleet/list-driver-groups.md): List the driver groups in your internal fleet, newest first.
- [Get Driver Group](https://docs.usenash.com/api-reference/fleet/get-driver-group.md): Read one driver group and the drivers in it.
- [Upsert Driver Group](https://docs.usenash.com/api-reference/fleet/upsert-driver-group.md): Create or update a driver group, keyed on your own identifier.
- [Update Delivery](https://docs.usenash.com/api-reference/fleet/update-delivery.md): Apply a partial update — such as status, courier location, proof of delivery, courier identity, or ETAs — to a delivery your organization owns. Only available for deliveries fulfilled by your own fleet (not by a third-party courier integration). Returns the updated delivery.
- [Bulk Update Deliveries](https://docs.usenash.com/api-reference/fleet/bulk-update-deliveries.md): Apply updates to up to 100 deliveries in a single request. Each item is keyed by exactly one of `deliveryId` or `packageExternalIdentifier` (your own id set on the package at creation), plus the same field set as the single-delivery endpoint. The per-item result echoes back the key you sent under `d…
- [Server Health Check](https://docs.usenash.com/api-reference/miscellaneous/server-health-check.md): Check the health of the Nash API server.
- [Release notes](https://docs.usenash.com/release-notes/change.md): What's new in Nash — features, improvements, and fixes, week over week.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)
- [Acronyms](/styles/Google/Acronyms.yml)
- [AMPM](/styles/Google/AMPM.yml)
- [Colons](/styles/Google/Colons.yml)
- [Contractions](/styles/Google/Contractions.yml)
- [DateFormat](/styles/Google/DateFormat.yml)
- [Ellipses](/styles/Google/Ellipses.yml)
- [EmDash](/styles/Google/EmDash.yml)
- [Exclamation](/styles/Google/Exclamation.yml)
- [FirstPerson](/styles/Google/FirstPerson.yml)
- [Gender](/styles/Google/Gender.yml)
- [GenderBias](/styles/Google/GenderBias.yml)
- [HeadingPunctuation](/styles/Google/HeadingPunctuation.yml)
- [Headings](/styles/Google/Headings.yml)
- [Latin](/styles/Google/Latin.yml)
- [LyHyphens](/styles/Google/LyHyphens.yml)
- [meta](/styles/Google/meta.json)
- [OptionalPlurals](/styles/Google/OptionalPlurals.yml)
- [Ordinal](/styles/Google/Ordinal.yml)
- [OxfordComma](/styles/Google/OxfordComma.yml)
- [Parens](/styles/Google/Parens.yml)
- [Passive](/styles/Google/Passive.yml)
- [Periods](/styles/Google/Periods.yml)
- [Quotes](/styles/Google/Quotes.yml)
- [Ranges](/styles/Google/Ranges.yml)
- [Semicolons](/styles/Google/Semicolons.yml)
- [Slang](/styles/Google/Slang.yml)
- [Spacing](/styles/Google/Spacing.yml)
- [Spelling](/styles/Google/Spelling.yml)
- [Units](/styles/Google/Units.yml)
- [We](/styles/Google/We.yml)
- [Will](/styles/Google/Will.yml)
- [WordList](/styles/Google/WordList.yml)
- [Airlinese](/styles/proselint/Airlinese.yml)
- [AnimalLabels](/styles/proselint/AnimalLabels.yml)
- [Annotations](/styles/proselint/Annotations.yml)
- [Apologizing](/styles/proselint/Apologizing.yml)
- [Archaisms](/styles/proselint/Archaisms.yml)
- [But](/styles/proselint/But.yml)
- [Cliches](/styles/proselint/Cliches.yml)
- [CorporateSpeak](/styles/proselint/CorporateSpeak.yml)
- [Currency](/styles/proselint/Currency.yml)
- [Cursing](/styles/proselint/Cursing.yml)
- [DateCase](/styles/proselint/DateCase.yml)
- [DateMidnight](/styles/proselint/DateMidnight.yml)
- [DateRedundancy](/styles/proselint/DateRedundancy.yml)
- [DateSpacing](/styles/proselint/DateSpacing.yml)
- [DenizenLabels](/styles/proselint/DenizenLabels.yml)
- [Diacritical](/styles/proselint/Diacritical.yml)
- [GenderBias](/styles/proselint/GenderBias.yml)
- [GroupTerms](/styles/proselint/GroupTerms.yml)
- [Hedging](/styles/proselint/Hedging.yml)
- [Hyperbole](/styles/proselint/Hyperbole.yml)
- [Jargon](/styles/proselint/Jargon.yml)
- [LGBTOffensive](/styles/proselint/LGBTOffensive.yml)
- [LGBTTerms](/styles/proselint/LGBTTerms.yml)
- [Malapropisms](/styles/proselint/Malapropisms.yml)
- [meta](/styles/proselint/meta.json)
- [Needless](/styles/proselint/Needless.yml)
- [Nonwords](/styles/proselint/Nonwords.yml)
- [Oxymorons](/styles/proselint/Oxymorons.yml)
- [P-Value](/styles/proselint/P-Value.yml)
- [RASSyndrome](/styles/proselint/RASSyndrome.yml)
- [Skunked](/styles/proselint/Skunked.yml)
- [Spelling](/styles/proselint/Spelling.yml)
- [Typography](/styles/proselint/Typography.yml)
- [Uncomparables](/styles/proselint/Uncomparables.yml)
- [Very](/styles/proselint/Very.yml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.