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.
UpdateOrderBulkPayload
object
2 properties
2 required
BulkOperationResult
object
4 properties
3 required
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties
1 required
ReturnedJobMixin
object
A Nash Job.
13 properties
6 required
OrderInputWithReturnFirstQuoteApiOnly
object
70 properties
BulkUpsertError
object
Error detail for a row whose status is failed.
2 properties
2 required
BulkOperationResponse
object
2 properties
2 required
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property
1 required
NashErrorDetails
object
3 properties
2 required
CreateOrdersInput
object
1 property
1 required
ItemOutput
object
Item object returned by the API.
11 properties
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties
4 required
AddEventInputSerializer
object
Expected payload for the add event endpoint.
3 properties
1 required
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties
6 required
OrderDocumentOutput
object
Document object returned by the API.
6 properties
4 required
PackageRequirements
string
Detailed description: https://docs.usenash.com/reference/package-requirements.
UpdateOrderInput
object
70 properties
1 required
RefreshOrderQuotesOutputExample
object
1 property
1 required
OrderLocationSummary
object
9 properties
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties
2 required
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties
5 required
PickupPaymentBarcode
object
2 properties
VehicleSerializer
object
Vehicle details for a route.
6 properties
UpsertOrderInput
object
70 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
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties
2 required
CourierSerializer
object
Courier details for a route.
4 properties
EligibleDeliveryWindow
object
21 properties
7 required
BulkUpsertResult_BulkUpsertOrderData_
object
5 properties
1 required
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties
4 required
OrderInput
object
Order input for creating an order.
69 properties
UpsertOrderBulkPayload
object
2 properties
2 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
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties
3 required
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
SubstituteItemObject
object
3 properties
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties
4 required
RefreshOrderQuotesInput
object
Input for refreshing quotes for an order.
2 properties
DeleteOrderBulkPayload
object
2 properties
2 required
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 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
DriverGroupSerializer
object
Driver group details for a route.
2 properties
BasicUserSerializer
object
Generic serializer for basic users used in many endpoints.
1 property
1 required
ItemStatusHistoryEntrySerializer
object
A single status change entry in an item's status history.
2 properties
2 required
OptimizationParameters
object
8 properties
BulkUpsertSummary
object
Counts of each outcome across the batch.
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
OrderIdPath
object
1 property
1 required
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties
2 required
LocationSerializer
object
Generic serializer for location used in many endpoints.
20 properties
7 required
OrderOutputExample
object
75 properties
6 required
OrdersListResponse
object
4 properties
4 required
PickupPayment
object
2 properties
SubItemOutput
object
Sub-item object returned by the API.
13 properties
OrderListItem
object
12 properties
1 required
TaskSerializer
object
Generic serializer for tasks used in many endpoints.
17 properties
3 required
SubItemInput
object
Sub-item input object for API requests.
13 properties
OrderWithDeliveryWindowInput
object
73 properties
StopOrderSerializer
object
Order information associated with a route stop.
5 properties
1 required
NashValidationError
object
3 properties
3 required
BulkOperationSummary
object
3 properties
3 required
SubstitutionObject
object
3 properties
DeliveryWindowOutput
object
Response for a delivery window.
22 properties
22 required
GetBulkOperationResponse
object
Bulk Operation Response for Orders.
3 properties
3 required
FullJobPayload
object
Expected output from autodispatch job endpoint.
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
EventOutputPayload
object
5 properties
4 required
JobConfigurationsSerializer
object
Generic serializer for jbo configurations used in many endpoints.
6 properties
3 required
AddEventOutputSerializer
object
1 property
1 required
CreateOrderBulkPayload
object
2 properties
2 required
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…
Dimensions
object
3 properties
OrderWithDeliveryWindowOutputExample
object
82 properties
6 required
ItemInput
object
Item input object for API requests.
11 properties
OrdersOutputExample
array
ActivityStatus
string
Status of an activity.
OrdersBulkOperationInput
array
OrderDocumentResponse
array
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Nash publishes across the network.
