Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nash Fleet API

Inbound endpoints fleets call to update in-flight deliveries.

Nash Fleet API is one of 30 APIs that Nash publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Fleet. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 4 base URLs: https://api.sandbox.usenash.com, https://api.sandbox.ap-southeast-2.usenash.com, https://api.usenash.com, https://api.ap-southeast-2.usenash.com.

2 operations 2 paths 20 schemas 2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.usenash.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nash Fleet API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 PATCH. Each is listed below with its method, path, parameters, and response codes.

Fleet 2

Inbound endpoints fleets call to update in-flight deliveries.

PATCH
/v1/fleet/deliveries
Bulk Update Deliveries
deliveries_v1_bulk_update_deliveries_route_patch body → 200422
PATCH
/v1/fleet/deliveries/{delivery_id}
Update Delivery
deliveries_v1_update_delivery_route__delivery_id__patch 1 param body → 200422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are DeliverySerializer (34 properties), BarcodeInfoSerializer (15 properties), BulkDeliveryUpdateItem (14 properties), PickedItemsSerializer (12 properties). Each schema is shown below with its type and property counts.

DeliveryStatusUpdateValue
string
Lifecycle states a fleet can report for a delivery. Ordered roughly chronologically: - notassigneddriver — provider received the dispatch but hasn't found a dr…
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
NashErrorDetails
object
3 properties 2 required
DeliveryUpdate
object
Partial update for a delivery dispatched to a Nash-connected provider.
12 properties
BarcodeProof
object
Barcode scan recorded at pickup, dropoff, or during a return.
3 properties 3 required
Courier
object
Identity and vehicle for the courier currently handling the delivery. Send the full block when a courier is first assigned, or any subset when one of the field…
7 properties
NashValidationError
object
3 properties 3 required
ImageProof
object
Image-based proof captured at pickup or dropoff (photo or signature).
2 properties 2 required
BulkDeliveryUpdateRequest
object
Top-level body for PATCH /v1/deliveries (bulk update).
1 property 1 required
BulkDeliveryUpdateItem
object
One update inside a bulk PATCH /v1/deliveries call. Same field set as DeliveryUpdate, keyed by exactly one of: - deliveryId — the Nash delivery id, or - packag…
14 properties
CourierVehicle
object
Vehicle the courier is using to fulfill the delivery.
4 properties
Coordinates
object
Latitude / longitude pair for the courier's current location.
2 properties 2 required
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
BulkDeliveryUpdateResponse
object
Top-level response for PATCH /v1/deliveries.
1 property 1 required
DeliveryFailureCode
string
Structured failure / cancellation code paired with optional free-text reason. Stable across providers so analytics, reassignment policy, and merchant notificat…
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties 4 required
DeliveryFailure
object
Structured cause when a delivery enters failed or canceledbyprovider.
2 properties 1 required
DeliverySerializer
object
Generic serializer for deliveries used in many endpoints. Some endpoints won't return all fields, so they are optional. This means that they will return field…
34 properties 5 required
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
BulkDeliveryUpdateResultItem
object
Per-item result for a bulk update. On success, delivery carries the same shape returned under each task by GET /v1/jobs/ (the canonical DeliverySerializer shap…
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-fleet-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
Nash Annotate API
Nash Batch Job API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Job API
Nash Messaging API
Nash Miscellaneous API
Nash Notifications API