Nash Batch 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 Batch Job. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.
This API exposes
4 operations
across 4 paths,
and defines 44 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.
4 operations4 paths44 schemas1 PATCH3 POST
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 Batch Job API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT, API Key) (Token).
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Batch Job 4
Batch Job
POST
/v1/batch_job
Create Batch Job
create_batch_job_v1_batch_job_postbody→ 200422
PATCH
/v1/jobs/{id}/{jobConfigurationId}
Update Job by JobID/ExternalIdentifier and Job Configuration ID
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PackageSchemaMixin (49 properties), UpdateJobInputSerializer (39 properties), DeliverySerializer (34 properties), PackageSerializer (32 properties). Each schema is shown below with its type and property counts.
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties6 required
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties2 required
NashErrorDetails
object
3 properties2 required
ReturnedJobMixin
object
A Nash Job.
13 properties6 required
DriverGroupSerializer
object
Driver group details for a route.
2 properties
VehicleSerializer
object
Vehicle details for a route.
6 properties
ParsedAddressInputSerializer
object
Parsed address input serializer for creating a job.
10 properties3 required
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties4 required
UpdateJobInputSerializer
object
Expected input for update job endpoint.
39 properties
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property1 required
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties5 required
SubItemOutput
object
Sub-item object returned by the API.
13 properties
BatchSerializer
object
Generic serializer for batches used in many endpoints.
Generic serializer for tasks used in many endpoints.
17 properties3 required
ReturnedBatchJobMixin
object
The format for a returned batch job used in many endpoints.
12 properties8 required
RefreshBatchQuotesOutputSerializer
object
Expected output after refreshing quotes for a batch job.
2 properties2 required
CourierSerializer
object
Courier details for a route.
4 properties
Dimensions
object
3 properties
ItemOutput
object
Item object returned by the API.
11 properties
BasicUserSerializer
object
Generic serializer for basic users used in many endpoints.
1 property1 required
StopOrderSerializer
object
Order information associated with a route stop.
5 properties1 required
BatchStopTypes
string
Various stop types for batch and route object.
ItemStatusHistoryEntrySerializer
object
A single status change entry in an item's status history.
2 properties2 required
JobConfigurationsSerializer
object
Generic serializer for jbo configurations used in many endpoints.
6 properties3 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
PackageSchemaMixin
object
Generic mixin for packages used in many endpoints; Used for input.
49 properties1 required
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
6 properties
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
SubstitutionObject
object
3 properties
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties4 required
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties2 required
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties1 required
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties4 required
CreateBatchJobInputSerializer
object
Expected input for creating a batch job.
5 properties1 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 properties5 required
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
LocationSerializer
object
Generic serializer for location used in many endpoints.
20 properties7 required
FullJobPayload
object
Expected output from autodispatch job endpoint.
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
