Nash Order 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 Order. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.
This API exposes
22 operations
across 19 paths,
and defines 82 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.
OrdersBulkOperationInput
array
OrderDocumentResponse
array
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties
4 required
UpsertOrderBulkPayload
object
2 properties
2 required
Dimensions
object
3 properties
OrderItemSerializer
object
Item with status tracking for route stop webhook payloads. Combines item definition with lifecycle status from the route state machine.
12 properties
BulkOperationResponse
object
2 properties
2 required
AddEventOutputSerializer
object
1 property
1 required
EligibleDeliveryWindow
object
21 properties
7 required
EventOutputPayload
object
5 properties
4 required
BulkOperationResult
object
4 properties
3 required
CreateOrderBulkPayload
object
2 properties
2 required
BasicUserSerializer
object
Generic serializer for basic users used in many endpoints.
1 property
1 required
BulkUpsertOrderData
object
The full upserted order returned in a successful v2 bulk-upsert result. Subclasses OrderOutputExample only to enable serialising directly from the Order ORM in…
75 properties
6 required
UpdateOrderInput
object
70 properties
1 required
BulkUpsertResult_BulkUpsertOrderData_
object
5 properties
1 required
UpdateOrderBulkPayload
object
2 properties
2 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
ItemStatusHistoryEntrySerializer
object
A single status change entry in an item's status history.
2 properties
2 required
TaskSerializer
object
Generic serializer for tasks used in many endpoints.
17 properties
3 required
SubstituteItemObject
object
3 properties
DeliveryWindowOutput
object
Response for a delivery window.
22 properties
22 required
BulkUpsertError
object
Error detail for a row whose status is failed.
2 properties
2 required
OrderWithDeliveryWindowInput
object
73 properties
BulkOperationSummary
object
3 properties
3 required
OrderWithDeliveryWindowOutputExample
object
82 properties
6 required
DriverGroupSerializer
object
Driver group details for a route.
2 properties
OrderLocationSummary
object
9 properties
StopOrderSerializer
object
Order information associated with a route stop.
5 properties
1 required
OrderListItem
object
12 properties
1 required
OrderDocumentOutput
object
Document object returned by the API.
6 properties
4 required
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties
4 required
FullJobPayload
object
Expected output from autodispatch job endpoint.
1 property
1 required
ActivityStatus
string
Status of an activity.
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
6 properties
SubItemInput
object
Sub-item input object for API requests.
13 properties
NashErrorDetails
object
3 properties
2 required
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties
2 required
PackageRequirements
string
Detailed description: https://docs.usenash.com/reference/package-requirements.
DeleteOrderBulkPayload
object
2 properties
2 required
PickupPayment
object
2 properties
GetBulkOperationResponse
object
Bulk Operation Response for Orders.
3 properties
3 required
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties
3 required
PickupPaymentBarcode
object
2 properties
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property
1 required
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties
2 required
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
RefreshOrderQuotesOutputExample
object
1 property
1 required
OrderResponse
object
OrderOutputExample serialisable directly from an Order ORM instance via modelvalidate(order) — the standard order response for layered order endpoints that ret…
75 properties
6 required
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties
6 required
OrdersOutputExample
array
OrderInput
object
Order input for creating an order.
69 properties
ItemOutput
object
Item object returned by the API.
11 properties
CreateOrdersInput
object
1 property
1 required
AddEventInputSerializer
object
Expected payload for the add event endpoint.
3 properties
1 required
VehicleSerializer
object
Vehicle details for a route.
6 properties
OptimizationParameters
object
8 properties
NashValidationError
object
3 properties
3 required
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties
4 required
OrderOutputExample
object
75 properties
6 required
JobConfigurationsSerializer
object
Generic serializer for jbo configurations used in many endpoints.
6 properties
3 required
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties
5 required
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
CourierSerializer
object
Courier details for a route.
4 properties
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
BulkUpsertOrdersResponse
object
Response for POST /v2/orders/upsert/bulk. The orders specialisation of the generic BulkUpsertResponse envelope: data on each result is a full BulkUpsertOrderDa…
2 properties
2 required
ItemInput
object
Item input object for API requests.
11 properties
SubstitutionObject
object
3 properties
OrdersListResponse
object
4 properties
4 required
ReturnedJobMixin
object
A Nash Job.
13 properties
6 required
OrderIdPath
object
1 property
1 required
OrderInputWithReturnFirstQuoteApiOnly
object
70 properties
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
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties
2 required
RefreshOrderQuotesInput
object
Input for refreshing quotes for an order.
2 properties
BulkUpsertSummary
object
Counts of each outcome across the batch.
2 properties
2 required
SubItemOutput
object
Sub-item object returned by the API.
13 properties
BulkUpsertStatus
string
Per-row outcome of a bulk upsert. success means the row was upserted (created or updated). failed is reserved for hard errors (a precondition violation, lock c…
UpsertOrderInput
object
70 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Nash publishes across the network.
