How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nash Batch Job API

Batch Job

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.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.

4 operations 4 paths 44 schemas 1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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_post body → 200422
PATCH
/v1/jobs/{id}/{jobConfigurationId}
Update Job by JobID/ExternalIdentifier and Job Configuration ID
update_job_v1_jobs__string_id___string_jobConfigurationId__patch 2 params body → 200422
POST
/v1/jobs/{jobId}/batch/{batchId}/refresh_quotes
Refresh Quotes by Job ID and Batch ID
refresh_quotes_batch_v1_jobs__string_jobId__batch__string_batchId__refresh_quotes_post 2 params → 200422
POST
/v1/jobs/{jobId}/{objectId}/cancel
Cancel Job by Job ID and Task or Job Configuration ID
cancel_job_v1_jobs__string_jobId___string_objectId__cancel_post 2 params → 200422

Schemas 44

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.

NashValidationError
object
3 properties 3 required
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties 4 required
JobConfigurationsSerializer
object
Generic serializer for jbo configurations used in many endpoints.
6 properties 3 required
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties 3 required
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties 5 required
UpdateJobInputSerializer
object
Expected input for update job endpoint.
39 properties
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties 4 required
Dimensions
object
3 properties
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property 1 required
DriverGroupSerializer
object
Driver group details for a route.
2 properties
CourierSerializer
object
Courier details for a route.
4 properties
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties 2 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
BatchSerializer
object
Generic serializer for batches used in many endpoints.
9 properties 5 required
SubstitutionObject
object
3 properties
StopOrderSerializer
object
Order information associated with a route stop.
5 properties 1 required
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
BasicUserSerializer
object
Generic serializer for basic users used in many endpoints.
1 property 1 required
CreateBatchJobInputSerializer
object
Expected input for creating a batch job.
5 properties 1 required
ReturnedBatchJobMixin
object
The format for a returned batch job used in many endpoints.
12 properties 8 required
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties 4 required
ReturnedJobMixin
object
A Nash Job.
13 properties 6 required
PackageSchemaMixin
object
Generic mixin for packages used in many endpoints; Used for input.
49 properties 1 required
FullJobPayload
object
Expected output from autodispatch job endpoint.
1 property 1 required
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties 6 required
ParsedAddressInputSerializer
object
Parsed address input serializer for creating a job.
10 properties 3 required
ItemOutput
object
Item object returned by the API.
11 properties
RefreshBatchQuotesOutputSerializer
object
Expected output after refreshing quotes for a batch job.
2 properties 2 required
LocationSerializer
object
Generic serializer for location used in many endpoints.
20 properties 7 required
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties 1 required
BatchStopTypes
string
Various stop types for batch and route object.
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
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
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties 2 required
NashErrorDetails
object
3 properties 2 required
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties 2 required
TaskSerializer
object
Generic serializer for tasks used in many endpoints.
17 properties 3 required
SubstituteItemObject
object
3 properties
SubItemOutput
object
Sub-item object returned by the API.
13 properties
VehicleSerializer
object
Vehicle details for a route.
6 properties
PackageRequirements
string
Detailed description: https://docs.usenash.com/reference/package-requirements.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-batch-job-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
Nash Annotate API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Fleet API
Nash Job API
Nash Messaging API
Nash Miscellaneous API
Nash Notifications API
Where this information came from

This is an independent, third-party profile of Nash Batch Job API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.