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.2.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.
The identity and technical contract details declared by the specification.
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties
5 required
TaskSerializer
object
Generic serializer for tasks used in many endpoints.
17 properties
3 required
SelectQuoteOutputSerializer
object
Expected output when selecting a quote for a task, batch , order.
1 property
1 required
DeliveryIncidentOutputSerializer
object
12 properties
8 required
JobLocationSummary
object
7 properties
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
StopOrderSerializer
object
Order information associated with a route stop.
5 properties
1 required
UpdateJobInputSerializer
object
Expected input for update job endpoint.
39 properties
DriverGroupSerializer
object
Driver group details for a route.
2 properties
NashValidationError
object
3 properties
3 required
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties
1 required
SubstitutionObject
object
3 properties
SelectTaskQuoteOutputSerializer
object
Expected output when selecting a quote.
5 properties
2 required
DeliveryIncidentInputSerializer
object
9 properties
2 required
BatchSerializer
object
Generic serializer for batches used in many endpoints.
9 properties
5 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.
FullJobPayload
object
Expected output from autodispatch job endpoint.
1 property
1 required
ReturnedJobMixin
object
A Nash Job.
13 properties
6 required
SelectQuoteInputSerializer
object
Expected input for selecting a quote.
1 property
1 required
VehicleSerializer
object
Vehicle details for a route.
6 properties
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
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
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties
2 required
ParsedAddressInputSerializer
object
Parsed address input serializer for creating a job.
10 properties
3 required
RefundRequestResponse
object
Response for refund request.
20 properties
19 required
RefreshQuotesOutputSerializer
object
Expected output for refreshing quotes.
2 properties
2 required
JobListItem
object
11 properties
1 required
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property
1 required
CourierSerializer
object
Courier details for a route.
4 properties
Dimensions
object
3 properties
ListRefundRequestResponse
array
Expected output for listing refund requests.
OrderItemSerializer
object
Item with status tracking for route stop webhook payloads. Combines item definition with lifecycle status from the route state machine.
12 properties
NashErrorDetails
object
3 properties
2 required
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties
2 required
JobDeliverySummary
object
7 properties
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties
4 required
LocationSerializer
object
Generic serializer for location used in many endpoints.
20 properties
7 required
ReassignTaskInputSerializer
object
Body for reassign task endpoint.
5 properties
ItemOutput
object
Item object returned by the API.
11 properties
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties
3 required
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties
4 required
RebookJobBody
object
Body for rebook job endpoint.
4 properties
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
6 properties
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties
6 required
CreateJobInputSerializerAndAutodispatch
object
Expected payload for creating a job and optionally autodispatch.
55 properties
1 required
JobsListResponse
object
4 properties
4 required
ReturnedBatchJobMixin
object
The format for a returned batch job used in many endpoints.
12 properties
8 required
CreateJobInputSerializer
object
Expected payload for creating a job.
54 properties
1 required
SubstituteItemObject
object
3 properties
SubItemOutput
object
Sub-item object returned by the API.
13 properties
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties
4 required
PackageRequirements
string
Detailed description: https://docs.usenash.com/reference/package-requirements.
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Nash publishes across the network.
