Create or update order by external identifier
This endpoint allows you to create and/or update an order by specifying an ID. Using this endpoint is relevant for checkout workflows, where you can create an order based on the customers cart / order ID and then update it once the customer completes the checkout.
Note: Create or Update Order by External Identifier behavior: If two requests with the same external_id are received, Nash will block the second request until the first request has been committed to the db and the response has been sent to the client. After that, the second request will be processed as an update since the order has already been created by the first request. This ensures that only one order is created per external_id, even when multiple requests are made simultaneously.
Path Parameters
The external id of the order to update
Body
Order input for creating an order.
The time at which the booked delivery window slot expires
Local currency
'now' or 'scheduled' when the delivery should be scheduled
The total depth of the package in centimeters (cm)
Order description and notes. Limited to 280 characters.
The dispatch strategy id (or option group id) to be associated with the order
The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].
The city of the dropoff address.
The ISO 3166-1 alpha-2 country code of the dropoff address.
The county associated with the dropoff address.
The street of the address.
The number on a house.
Secondary number on an address e.g. an apartment building.
The state of the dropoff address.
The zip or postal code of the dropoff address.
Array containing barcode values/types that are required to be scanned at the dropoff waypoint.
Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.
The email of the contact at the dropoff location.
The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'
First name of the contact at the destination. Limited to 80 characters.
Any special instructions for dropoff. Limited to 280 characters.
Last name of the contact at the destination. Limited to 80 characters.
The dropoff latitude coordinate.
The dropoff longitude coordinate.
The phone number to contact at the dropoff location in the form: '+15555555555'
Google place id for the dropoff location.
The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'
Order unique identifier from an external system. Used to group orders together. You should use it when you have multiple deliveries for one order in your system.
Order unique identifier from an external system.
The total height of the package in centimeters (cm)
Lists of items in the delivery
The number of items in this order
The requested minimum vehicle size.
Order-level optimization parameters
Key-value data to attach to this order.
The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].
The city of the pickup address.
The ISO 3166-1 alpha-2 country code of the pickup address.
The county associated with the pickup address.
The street of the address.
The number on a house.
Secondary number on an address e.g. an apartment building.
The state of the pickup address.
The zip or postal code of the pickup address.
Array containing barcode values that are required to be scanned at the pickup waypoint.
Pickup business name at the origin. Limited to 80 characters.
The email of the contact at the pickup location.
The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'
The external identifier used for your store.
First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.
Any special instructions for pickup. Limited to 280 characters.
Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.
The pickup latitude coordinate.
The pickup longitude coordinate.
The phone number to contact at the pickup location in the form: '+15555555555'
Google place id for the pickup location.
The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'
A unique identifier for store location created in Nash.
A non-unique identifier for orders, visible to the courier if supported by the provider.
Specify the delivery window slot that the end customer requested this order to be delivered in
The latest delivery window slot end time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'
The earliest delivery window slot start time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'
Package requirements.
photo_proof_of_delivery, signature_proof_of_delivery, photo_proof_of_pickup, signature_proof_of_pickup, age_verification_on_delivery, id_verification_on_delivery, barcode_scan_on_pickup, barcode_scan_on_dropoff, meet_on_delivery, shipping_label, two_person_team, pincode_verification, schedule_ii_controlled_substances, alcohol, parking_check_in Optional order tags, they will be included in every response
Tip paid to the driver in cents
Order value in cents
The total weight of the package in kilograms (kg)
The total width of the package in centimeters (cm)
Response
The date and time when the order was created
The id of the order
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
The delivery window time slot that the end customer requested this order to be delivered in.
The currency of the order
The delivery mode of the order
The depth of the order in cm
The description of the order
The dispatch strategy id of the order
The documents of the order
The dropoff address of the order
The city of the dropoff address.
The ISO 3166-1 alpha-2 country code of the dropoff address.
The county associated with the dropoff address.
The street of the address.
The number on a house.
Secondary number on an address e.g. an apartment building.
The state of the dropoff address.
The zip or postal code of the dropoff address.
Array containing barcode values that are required to be scanned at the dropoff waypoint.
Dropoff business name at the destination.
The end time of the dropoff window.
First name of the contact at the destination.
Any special instructions for dropoff.
Last name of the contact at the destination.
The dropoff latitude coordinate.
The dropoff longitude coordinate.
The phone number to contact at the dropoff location in the form: '+15555555555'
Google place id for the dropoff location.
The start time of the dropoff window.
A unique identifier for store location created in Nash.
The delivery window time slots that the customers can choose from.
Order unique identifier from an external system. Used to group orders together. You should use it when you have multiple deliveries for one order in your system.
The external id of the order
The failed quotes of the order
The height of the order in cm
The items of the order
The number of items in the order
The requested minimum vehicle size.
Key-value data to attach to Nash Jobs.
The pickup address of the order
The city of the pickup address.
The ISO 3166-1 alpha-2 country code of the pickup address.
The county associated with the pickup address.
The street of the address.
The number on a house.
Secondary number on an address e.g. an apartment building.
The state of the pickup address.
The zip or postal code of the pickup address.
Array containing barcode values that are required to be scanned at the pickup waypoint.
Pickup business name at the origin.
The end time of the pickup window.
The external identifier used for your store.
First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.
Any special instructions for pickup.
Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.
The pickup latitude coordinate.
The pickup longitude coordinate.
The phone number to contact at the pickup location in the form: '+15555555555'
Google place id for the pickup location.
The start time of the pickup window.
A unique identifier for store location created in Nash.
The quotes of the order
A non-unique identifier for orders, visible to the courier if supported by the provider.
The requirements of the order
The tip amount of the order in cents
The validation errors of the order
The value of the order in cents
The volume of the order in cm^3
The weight of the order in kg
The width of the order in cm