v1
latestOpenAPI 3.1.02026-07-2296226496.3 KBArchive order
Archive (soft-delete) an order. Archived orders are hidden from default listings but can be restored using the unarchive endpoint.
Path parameters
Unique reference number for the order: either order.id (starts with "ord_") or order.externalId
Unique reference number for the order: either order.id (starts with "ord_") or order.externalId
Response
OK
The id of the order
The date and time when the order was created
The external id of the order
The external group id of the order
A non-unique identifier for orders, visible to the courier if supported by the provider.
The URL of the order in the Nash portal
The URL of the order in the public tracking system
The status of the order
The tags of the order
Key-value data to attach to Nash Jobs.
The pickup address of the order
Google place id for the pickup location.
The number on a house.
Secondary number on an address e.g. an apartment building.
The street of the address.
The city of the pickup address.
The county associated with the pickup address.
The state of the pickup address.
The zip or postal code of the pickup address.
The ISO 3166-1 alpha-2 country code of the pickup address.
The pickup latitude coordinate.
The pickup longitude coordinate.
The phone number to contact at the pickup location in the form: '+15555555555'
First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.
Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.
Pickup business name at the origin.
Any special instructions for pickup.
A unique identifier for store location created in Nash.
The external identifier used for your store.
A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.
Array containing barcode values that are required to be scanned at the pickup waypoint.
The dropoff address of the order
Google place id for the dropoff location.
The number on a house.
Secondary number on an address e.g. an apartment building.
The street of the address.
The city of the dropoff address.
The county associated with the dropoff address.
The state of the dropoff address.
The zip or postal code of the dropoff address.
The ISO 3166-1 alpha-2 country code of the dropoff address.
The dropoff latitude coordinate.
The dropoff longitude coordinate.
The phone number to contact at the dropoff location in the form: '+15555555555'
First name of the contact at the destination.
Last name of the contact at the destination.
Dropoff business name at the destination.
Any special instructions for dropoff.
A unique identifier for store location created in Nash.
Array containing barcode values that are required to be scanned at the dropoff waypoint.
The delivery mode of the order
The start time of the pickup window.
The end time of the pickup window.
The start time of the dropoff window.
The end time of the dropoff window.
The description of the order
The number of items in the order
The requirements of the order
The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']
The currency of the order
The value of the order in cents
The tip amount of the order in cents
The width of the order in cm
The depth of the order in cm
The height of the order in cm
The volume of the order in cm^3
The weight of the order in kg
The dispatch strategy id (or option group id) to be associated with the order. Note: It is the best practice to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.
The max delivery fee of the order in cents
The validation errors of the order
The failed quotes of the order