Nash

Docs

• Cancel Batch Job: This endpoint allows you to cancel a batch job by job ID and task or job configuration ID.
• Create Batch Job: Create a job with multiple packages
• Refresh Quotes (Batch): Refresh the quotes for a batch job.
• Select Quote (Batch): Select the quote you would like to execute from a specific job.
• Update 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.
• Book a delivery window for order: 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: Confirm a previously booked delivery window for an order. Finalizes the booking and commits the capacity reservation.
• Create a single delivery window: 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: Retrieve a single delivery window by ID, including its time slot, capacity, and status.
• Revoke a delivery window for order: Revoke a previously booked delivery window for an order. Releases the capacity reservation and disassociates the window from the order.
• Create dispatch strategy: Create a new dispatch strategy (options group) with provider selection rules, fallback logic, and quoting configuration.
• Automations
• Dispatch Strategies
• Get Dispatch Strategies: List your organization's dispatch strategies.
• Update dispatch strategy: Update an existing dispatch strategy's provider selection rules, fallback logic, or quoting configuration. Only provided fields are updated.
• Add Delivery Feedback: Submit feedback for a completed delivery, such as a rating or comments about the delivery experience.
• Add Delivery Feedback by External Identifier: Submit feedback for a completed delivery using your external identifier instead of the Nash delivery ID.
• Simulate Delivery Status Transition: Advance a delivery to a given status for testing in sandbox.
• Bulk Update Deliveries: Apply updates to up to 100 deliveries in a single request. Each item carries a deliveryId plus the same field set as the single-delivery endpoint. Per-item failures come back as a structured error in the response and do not affect the rest of the batch.
• Overview: How a fleet reports delivery state back to Nash.
• Update Delivery: 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.
• Nash API: Nash API is the gateway to our delivery orchestration platform.
• Autodispatch Job: Automatically select a quote based on dispatch strategy
• Autodispatch Job by External Identifier: Automatically select a quote based on dispatch strategy
• Cancel Job by External Identifier: Cancels a Nash Job by the Partner's External ID if one was supplied at job creation.
• Cancel Job: 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).
• Create Delivery Incident: Create a new delivery incident for a task
• Create Job: Create a new job (delivery)
• Create or Update Job by External Identifier: 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.
• Get Job: Retrieve a job by its ID.
• Get Job by External Identifier: Retrieve a job by its external identifier.
• Get Refund Request: Retrieve a refund request by its ID.
• Get Refund Requests: Retrieve a list of refund requests by task ID or job ID.
• Background: Overview of Nash Jobs
• Reassign a Task: Create a new task in a job based on a given job ID and task ID.
• Refresh Quotes: Regenerate quotes for a given job's task.
• Select Quote: Select the quote you would like to execute from a specific job.
• Update 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.
• Server Health Check: Check the health of the Nash API server.
• Add Contact to the Deny List: Adds a contact to the deny list to opt the user out of communications.
• Get Contacts in the Deny List: Retrieves a list of contacts that have opted out of communications.
• Notifications
• Remove Contact from the Deny List: Removes a contact from the deny list to opt the user back into communications.
• Add Custom Event to 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.
• Archive order: Archive (soft-delete) an order. Archived orders are hidden from default listings but can be restored using the unarchive endpoint.
• Autodispatch Order: Automatically select a quote based on the order's dispatch stategy.
• Confirm order: Confirm a valid order, changing its status from 'valid' to 'confirmed'.
• Create or update order by external identifier: Create a new order or update an existing one using your external identifier. If an order with the given external identifier exists, it is updated; otherwise a new order is created.
• Create or Update Orders by External Identifier: Create or update multiple orders by external identifier in Nash
• Create Order: Create an order in Nash
• Create Orders: Create multiple pre-dispatch orders in a single request. Each order is created independently with its own pickup and dropoff details.
• Bulk Order Actions: Create, update, upsert, or delete orders asynchronously in bulk.
• Get order: Retrieve a single order by ID, including its pickup/dropoff details, status, and metadata.
• Get Order Documents: Get the documents for an order
• Create Quote: Create a new quote for an order
• Get Bulk Order Response: Get the response from an asynchronous bulk order operation.
• Background: Overview of Nash Orders (and their relation to Jobs)
• Order Address Validation (Geocoding)
• Order Requirements
• Order Validations
• Refresh order quotes: Request fresh price quotes from delivery providers for an existing order. Replaces any existing quotes with updated pricing from available providers.
• Select Quote: Select the quote you would like to execute from a specific order.
• Unarchive order: Restore a previously archived order, making it visible in default listings again.
• Update order: Update an existing pre-dispatch order's details such as addresses, times, or metadata. Only provided fields are updated.
• Upsert order by external identifier with delivery window: 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 Providers: This endpoint allows you to get all available providers in your organization.
• Create or Update Route: Create or update a route in Nash
• Dispatch Routes: Dispatch one or more routes to delivery providers. Creates jobs for each route and assigns them based on the organization's dispatch strategy.
• Get Route: Retrieve a route by ID, including its stops, travel metrics, and associated orders.
• Create a shift: Create a courier shift with start/end times and an assigned store location.
• Get a shift: Retrieve a single courier shift by ID, including its times, assigned courier, and store location.
• Get all shifts: 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.
• Dispatch and Manifest Orders: Create, autodispatch, and manifest shipping orders in a single request. Each order is created, autodispatched using the org's dispatch strategy, then manifested with the provider it landed on. Per-order failures are returned in errors instead of aborting the batch. shippingDetails on an order, i…
• Manifest Orders: Create manifests for dispatched shipping orders. Groups orders by store location and provider, then generates manifest documents (e.g. AusPost order summaries).
• Create or update inventory: Create or update inventory levels for products at specific store locations. Links products to store locations with quantity and availability information.
• Create or update products: Create new products or update existing ones in the store catalog. Products are matched by external identifier for upsert logic.
• Get inventory: List inventory levels with pagination. Filter by external store location ID or external product ID.
• Get products: List products in the store catalog with pagination and optional filtering. Filter by IDs, SKUs, text search, or semantic search.
• Background: Overview of Pick and Pack across Orders, Product Catalog, and Store Inventory
• Create or update store location by external identifier: 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 store location: Create a new store location (pickup point) with address, hours, and capacity settings.
• Delete store location: Delete a store location by ID. Orders referencing this store location will no longer have a valid pickup point.
• Get Store Location: Get a store location by ID.
• Get store location by external identifier: Retrieve a store location using your external identifier instead of the Nash store location ID.
• Get Store Locations: Get a list of store locations.
• Get store locations that cover specified location (latitude & longitude, city_zipcode): Find store locations whose delivery zones cover a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching store locations.
• Update Store Location: Update a store location by ID.
• Upsert multiple templates: Create or update multiple notification templates in a single request. Templates define the content and format of notifications sent for delivery events.
• Using LLMs with Nash API: A guide to leveraging LLMs for Nash API integration and development
• Create a zone: Create a geographic zone defined by a polygon boundary. Zones are used to define delivery areas for store locations and apply zone-based restrictions.
• Delete a zone: Delete a zone by ID. Removes the zone and its store location associations.
• Get zone: Retrieve a single zone by ID, including its polygon boundary and associated store locations.
• Get zone by external identifier: Retrieve a zone using your external identifier instead of the Nash zone ID.
• Get zones: List zones for the organization with pagination. Use size and offset parameters to paginate. Optionally include deleted zones with is_deleted.
• Get zones that cover specified location (latitude & longitude, city_zipcode): Find zones whose polygon boundaries contain a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching zones.
• Update a zone: Update an existing zone's name, polygon boundary, or associated store locations. Only provided fields are updated.
• Changelog
• API Tutorial Example Workflow - Nom Nom Goods
• Sample Checkout Workflow
• Production Testing
• Route Optimization
• Authentication
• Delivery Status
• Environments
• Errors
• API Key and Org ID: How to retrieve an API Key and Organization ID from the Nash portal
• Welcome to Nash: The Most Reliable Way to Organize and Manage Delivery
• What is Nash?: A brief introduction to Nash and how it can help your business.
• Glossary
• What Nash Offers: Nash is a powerful delivery orchestration platform designed for businesses to streamline their delivery operations, reduce costs, and expand their reach.
• MCP Integration
• Nash API Overview
• Embedding the Nash Live-Tracking Experience
• Orchestration
• Plan Your Integration
• Rate-Limits & Request Throttling: Nash's APIs use rate-limiting mechanisms to control the number of requests an organization can make to the API.
• Webhooks

OpenAPI Specs

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