Nash Job 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 Job. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.
This API exposes 19 operations across 16 paths, and defines 59 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.
19 operations
16 paths
59 schemas
5 GET1 PATCH13 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Nash Job API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT, API Key) (Token).
Paths & Operations 19
Across 16 paths, the API surfaces 19 operations — 5 GET, 1 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.
Job 19
Job
GET
/v1/jobs
List/Search Jobs
POST
/v1/jobs
Create Job
GET
/v1/jobs/external_identifier/{externalIdentifier}
Get Job by External Identifier
POST
/v1/jobs/external_identifier/{externalIdentifier}
Create or Update Job by External Identifier
POST
/v1/jobs/external_identifier/{externalIdentifier}/autodispatch
Autodispatch job by external identifier
POST
/v1/jobs/external_identifier/{externalIdentifier}/cancel
Cancel Job by External Identifier
GET
/v1/jobs/{id}
Get Job
PATCH
/v1/jobs/{id}
Update Job by JobID/ExternalIdentifier
POST
/v1/jobs/{id}/autodispatch
Autodispatch job
POST
/v1/jobs/{id}/rebook
Rebook Job
POST
/v1/jobs/{id}/refresh
Refresh job
POST
/v1/jobs/{jobId}/cancel
Cancel Job by Job ID
POST
/v1/jobs/{jobId}/tasks/{taskId}/delivery_incident
Create delivery incident
POST
/v1/jobs/{jobId}/tasks/{taskId}/quotes
Select Quote by Job ID and Task ID
POST
/v1/jobs/{jobId}/tasks/{taskId}/refresh_quotes
Refresh Quotes by Job ID and Task ID
POST
/v1/jobs/{jobId}/{taskId}/reassign
Reassign task by Job ID and Task ID
GET
/v1/refund-request/{id}
Get Refund Request
GET
/v1/refund-requests
Get Refund Requests by Task ID or Job ID
POST
/v1/select_quote
Select Quote
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are CreateJobInputSerializerAndAutodispatch (55 properties), CreateJobInputSerializer (54 properties), UpdateJobInputSerializer (39 properties), DeliverySerializer (34 properties). Each schema is shown below with its type and property counts.
SelectQuoteInputSerializer
object
Expected input for selecting a quote.
1 property
1 required
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties
6 required
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties
2 required
NashErrorDetails
object
3 properties
2 required
DeliveryIncidentOutputSerializer
object
12 properties
8 required
ReturnedJobMixin
object
A Nash Job.
13 properties
6 required
DriverGroupSerializer
object
Driver group details for a route.
2 properties
VehicleSerializer
object
Vehicle details for a route.
6 properties
CreateJobInputSerializerAndAutodispatch
object
Expected payload for creating a job and optionally autodispatch.
55 properties
1 required
ParsedAddressInputSerializer
object
Parsed address input serializer for creating a job.
10 properties
3 required
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties
4 required
JobDeliverySummary
object
7 properties
JobsListResponse
object
4 properties
4 required
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property
1 required
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties
5 required
SelectQuoteOutputSerializer
object
Expected output when selecting a quote for a task, batch , order.
1 property
1 required
SubItemOutput
object
Sub-item object returned by the API.
13 properties
ReassignTaskInputSerializer
object
Body for reassign task endpoint.
5 properties
SelectTaskQuoteOutputSerializer
object
Expected output when selecting a quote.
5 properties
2 required
BatchSerializer
object
Generic serializer for batches used in many endpoints.
9 properties
5 required
PackageRequirements
string
Detailed description: https://docs.usenash.com/reference/package-requirements.
JobLocationSummary
object
7 properties
NashValidationError
object
3 properties
3 required
RebookJobBody
object
Body for rebook job endpoint.
4 properties
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties
2 required
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties
3 required
SubstituteItemObject
object
3 properties
RefundRequestType
string
TaskSerializer
object
Generic serializer for tasks used in many endpoints.
17 properties
3 required
CourierSerializer
object
Courier details for a route.
4 properties
ReturnedBatchJobMixin
object
The format for a returned batch job used in many endpoints.
12 properties
8 required
ListRefundRequestResponse
array
Expected output for listing refund requests.
Dimensions
object
3 properties
ItemOutput
object
Item object returned by the API.
11 properties
StopOrderSerializer
object
Order information associated with a route stop.
5 properties
1 required
BasicUserSerializer
object
Generic serializer for basic users used in many endpoints.
1 property
1 required
BatchStopTypes
string
Various stop types for batch and route object.
UpdateJobInputSerializer
object
Expected input for update job endpoint.
39 properties
ItemStatusHistoryEntrySerializer
object
A single status change entry in an item's status history.
2 properties
2 required
JobConfigurationsSerializer
object
Generic serializer for jbo configurations used in many endpoints.
6 properties
3 required
OrderItemSerializer
object
Item with status tracking for route stop webhook payloads. Combines item definition with lifecycle status from the route state machine.
12 properties
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
6 properties
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties
4 required
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties
2 required
SubstitutionObject
object
3 properties
RefundRequestResponse
object
Response for refund request.
20 properties
19 required
CreateJobInputSerializer
object
Expected payload for creating a job.
54 properties
1 required
RefundStatus
integer
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties
1 required
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties
4 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
DeliveryIncidentInputSerializer
object
9 properties
2 required
FullJobPayload
object
Expected output from autodispatch job endpoint.
1 property
1 required
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
LocationSerializer
object
Generic serializer for location used in many endpoints.
20 properties
7 required
RefreshQuotesOutputSerializer
object
Expected output for refreshing quotes.
2 properties
2 required
JobListItem
object
11 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nash 12
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 Fleet API
Nash Messaging API
Nash Miscellaneous API
Nash Notifications API
#Job