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.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.
22 operations
19 paths
82 schemas
1 DELETE4 GET3 PATCH14 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Nash Order API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT, API Key) (Token).
Paths & Operations 22
Across 19 paths, the API surfaces 22 operations — 1 DELETE, 4 GET, 3 PATCH, 14 POST. Each is listed below with its method, path, parameters, and response codes.
Order 22
Order
POST
/v1/order
Create Order
POST
/v1/order/external-identifier/{externalId}
Create or update order by external identifier
POST
/v1/order/external-identifier/{externalId}/autodispatch
Autodispatch order by external identifier
POST
/v1/order/external-identifier/{externalId}/delivery-window
Upsert order by external identifier with delivery window
POST
/v1/order/get_quotes
Get order quotes
POST
/v1/order/refresh_quotes
Refresh order quotes
GET
/v1/order/{id}
Get order
DELETE
/v1/order/{id}
Archive order
PATCH
/v1/order/{id}
Update order
POST
/v1/order/{id}/autodispatch
Autodispatch order
PATCH
/v1/order/{id}/confirm
Confirm order
GET
/v1/order/{id}/documents
Get order documents
POST
/v1/order/{id}/events
Add custom event to order
PATCH
/v1/order/{id}/unarchive
Unarchive order
GET
/v1/orders
List/Search Orders
POST
/v1/orders
Create Orders
POST
/v1/orders/bulk
Create, update, upsert, or delete orders asynchronously in bulk
GET
/v1/orders/bulk/{id}
Get response from asynchronous bulk order operation
POST
/v1/orders/external-identifier
Create or update orders by external identifier
POST
/v1/orders/external-identifier/{external_id}/undispatch
Undispatch an order
POST
/v1/orders/{order_id}/undispatch
Undispatch an order by id
POST
/v2/orders/upsert/bulk
Create or update orders by external identifier (v2)
Schemas 82
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are OrderWithDeliveryWindowOutputExample (82 properties), OrderOutputExample (75 properties), OrderResponse (75 properties), BulkUpsertOrderData (75 properties). Each schema is shown below with its type and property counts.
RefreshOrderQuotesOutputExample
object
1 property
1 required
NashErrorDetails
object
3 properties
2 required
OrderWithDeliveryWindowInput
object
73 properties
DriverGroupSerializer
object
Driver group details for a route.
2 properties
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
ItemInput
object
Item input object for API requests.
11 properties
UpdateOrderBulkPayload
object
2 properties
2 required
OrderLocationSummary
object
9 properties
NoteSerializer
object
Generic serializer for notes used in many endpoints.
4 properties
4 required
CompressedAdvancedTaskSerializer
object
Generic serializer for tasks used in many endpoints.
1 property
1 required
QuoteSerializer
object
Generic serializer for quotes used in many endpoints.
25 properties
5 required
SubItemOutput
object
Sub-item object returned by the API.
13 properties
UpsertOrderBulkPayload
object
2 properties
2 required
OrderListItem
object
12 properties
1 required
SubItemInput
object
Sub-item input object for API requests.
13 properties
CourierSerializer
object
Courier details for a route.
4 properties
BulkUpsertSummary
object
Counts of each outcome across the batch.
2 properties
2 required
ItemStatusHistoryEntrySerializer
object
A single status change entry in an item's status history.
2 properties
2 required
BulkUpsertResult_BulkUpsertOrderData_
object
5 properties
1 required
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
6 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…
EligibleDeliveryWindow
object
21 properties
7 required
OrdersListResponse
object
4 properties
4 required
ActivityStatus
string
Status of an activity.
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties
3 required
CreateOrderBulkPayload
object
2 properties
2 required
Dimensions
object
3 properties
BasicUserSerializer
object
Generic serializer for basic users used in many endpoints.
1 property
1 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
SubstitutionObject
object
3 properties
UpdateOrderInput
object
70 properties
1 required
BulkUpsertError
object
Error detail for a row whose status is failed.
2 properties
2 required
AddEventOutputSerializer
object
1 property
1 required
BarcodeInfoSerializer
object
Serializer for barcode information in scans.
15 properties
BulkOperationResult
object
4 properties
3 required
ReturnedJobMixin
object
A Nash Job.
13 properties
6 required
BulkOperationResponse
object
2 properties
2 required
VehicleSerializer
object
Vehicle details for a route.
6 properties
OrderInput
object
Order input for creating an order.
69 properties
DocumentType
string
BulkActionStatus
string
PickupPayment
object
2 properties
RefreshOrderQuotesInput
object
Input for refreshing quotes for an order.
2 properties
OrderDocumentOutput
object
Document object returned by the API.
6 properties
4 required
JobConfigurationsSerializer
object
Generic serializer for jbo configurations used in many endpoints.
6 properties
3 required
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties
4 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
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties
2 required
AddEventInputSerializer
object
Expected payload for the add event endpoint.
3 properties
1 required
FullJobPayload
object
Expected output from autodispatch job endpoint.
1 property
1 required
LocationSerializer
object
Generic serializer for location used in many endpoints.
20 properties
7 required
DeliveryWindowOutput
object
Response for a delivery window.
22 properties
22 required
OrdersOutputExample
array
BulkOperationSummary
object
3 properties
3 required
ItemScanSerializer
object
Serializer for individual item scans.
2 properties
PackageSerializer
object
Generic serializer for packages used in many endpoints; Used for output.
32 properties
6 required
OptionsGroupSerializer
object
Generic serializer for options groups used in many endpoints.
12 properties
2 required
OrdersBulkOperationInput
array
OrderIdPath
object
1 property
1 required
OrderInputWithReturnFirstQuoteApiOnly
object
70 properties
GetBulkOperationResponse
object
Bulk Operation Response for Orders.
3 properties
3 required
PackageRequirements
string
Detailed description: https://docs.usenash.com/reference/package-requirements.
OrderDocumentResponse
array
NashValidationError
object
3 properties
3 required
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties
2 required
SubstituteItemObject
object
3 properties
TaskSerializer
object
Generic serializer for tasks used in many endpoints.
17 properties
3 required
OrderOutputExample
object
75 properties
6 required
ItemOutput
object
Item object returned by the API.
11 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
StopOrderSerializer
object
Order information associated with a route stop.
5 properties
1 required
EventOutputPayload
object
5 properties
4 required
DeleteOrderBulkPayload
object
2 properties
2 required
CreateOrdersInput
object
1 property
1 required
PickedItemsSerializer
object
Generic serializer for picked items; Used for output.
12 properties
UpsertOrderInput
object
70 properties
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties
1 required
OrderWithDeliveryWindowOutputExample
object
82 properties
6 required
DocumentSerializer
object
Generic serializer for Nash documents; Used for output.
7 properties
4 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
PickupPaymentBarcode
object
2 properties
OptimizationParameters
object
8 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nash 12
Other APIs Nash publishes across the network.
Nash AI Functions API
Nash Annotate API
Nash Batch Job 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
#Order