Create Orders

Body

application/json

orders

object[]

required

List of orders to create

orders.bookedDeliveryWindowSlotExpiresAt

string | null

The time at which the booked delivery window slot expires

orders.currency

string | null

Local currency

orders.deliveryMode

string | null

'now' or 'scheduled' when the delivery should be scheduled

orders.depth

The total depth of the package in centimeters (cm)

orders.description

string | null

Order description and notes. Limited to 280 characters.

orders.dispatchStrategyId

string | null

The dispatch strategy id (or option group id) to be associated with the order

orders.dropoffAddress

string | null

The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].

orders.dropoffAddressCity

string | null

The city of the dropoff address.

orders.dropoffAddressCountry

string | null

The ISO 3166-1 alpha-2 country code of the dropoff address.

orders.dropoffAddressCounty

string | null

The county associated with the dropoff address.

orders.dropoffAddressFormattedStreet

string | null

The street of the address.

orders.dropoffAddressNumber

string | null

The number on a house.

orders.dropoffAddressSecondarynumber

string | null

Secondary number on an address e.g. an apartment building.

orders.dropoffAddressState

string | null

The state of the dropoff address.

orders.dropoffAddressZip

string | null

The zip or postal code of the dropoff address.

orders.dropoffBarcodes

string[] | null

Array containing barcode values/types that are required to be scanned at the dropoff waypoint.

orders.dropoffBusinessName

string | null

Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.

orders.dropoffEmail

string | null

The email of the contact at the dropoff location.

orders.dropoffEndTime

string | null

The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'

orders.dropoffFirstName

string | null

First name of the contact at the destination. Limited to 80 characters.

orders.dropoffInstructions

string | null

Any special instructions for dropoff. Limited to 280 characters.

orders.dropoffLastName

string | null

Last name of the contact at the destination. Limited to 80 characters.

orders.dropoffLat

number | null

The dropoff latitude coordinate.

orders.dropoffLng

number | null

The dropoff longitude coordinate.

orders.dropoffPhoneNumber

string | null

The phone number to contact at the dropoff location in the form: '+15555555555'

orders.dropoffPlaceId

string | null

Google place id for the dropoff location.

orders.dropoffStartTime

string | null

The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'

orders.externalGroupId

string | null

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.

orders.externalId

string | null

Order unique identifier from an external system.

orders.height

The total height of the package in centimeters (cm)

orders.items

object[] | null

Lists of items in the delivery

orders.itemsCount

integer | null

The number of items in this order

orders.minimumVehicleSize

string | null

The requested minimum vehicle size.

orders.optimizationParameters

object | null

Order-level optimization parameters

orders.orderMetadata

object | null

Key-value data to attach to this order.

orders.pickupAddress

string | null

The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].

orders.pickupAddressCity

string | null

The city of the pickup address.

orders.pickupAddressCountry

string | null

The ISO 3166-1 alpha-2 country code of the pickup address.

orders.pickupAddressCounty

string | null

The county associated with the pickup address.

orders.pickupAddressFormattedStreet

string | null

The street of the address.

orders.pickupAddressNumber

string | null

The number on a house.

orders.pickupAddressSecondarynumber

string | null

Secondary number on an address e.g. an apartment building.

orders.pickupAddressState

string | null

The state of the pickup address.

orders.pickupAddressZip

string | null

The zip or postal code of the pickup address.

orders.pickupBarcodes

string[] | null

Array containing barcode values that are required to be scanned at the pickup waypoint.

orders.pickupBusinessName

string | null

Pickup business name at the origin. Limited to 80 characters.

orders.pickupEmail

string | null

The email of the contact at the pickup location.

orders.pickupEndTime

string | null

The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'

orders.pickupExternalStoreLocationId

string | null

The external identifier used for your store.

orders.pickupFirstName

string | null

First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.

orders.pickupInstructions

string | null

Any special instructions for pickup. Limited to 280 characters.

orders.pickupLastName

string | null

Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.

orders.pickupLat

number | null

The pickup latitude coordinate.

orders.pickupLng

number | null

The pickup longitude coordinate.

orders.pickupPhoneNumber

string | null

The phone number to contact at the pickup location in the form: '+15555555555'

orders.pickupPlaceId

string | null

Google place id for the pickup location.

orders.pickupStartTime

string | null

The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'

orders.pickupStoreLocationId

string | null

A unique identifier for store location created in Nash.

orders.referenceId

string | null

A non-unique identifier for orders, visible to the courier if supported by the provider.

orders.requestedDeliveryWindowSlotId

string | null

Specify the delivery window slot that the end customer requested this order to be delivered in

orders.requestedDeliveryWindowSlotsEndTime

string | null

The latest delivery window slot end time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'

orders.requestedDeliveryWindowSlotsStartTime

string | null

The earliest delivery window slot start time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'

orders.requirements

Package requirements.

Available options:

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

orders.tags

string[] | null

Optional order tags, they will be included in every response

orders.tipAmountCents

integer | null

Tip paid to the driver in cents

orders.valueCents

Order value in cents

orders.weight

The total weight of the package in kilograms (kg)

orders.width

The total width of the package in centimeters (cm)

Response

200 - application/json

createdAt

string

required

The date and time when the order was created

string

required

The id of the order

portalUrl

string

required

The URL of the order in the Nash portal

publicTrackingUrl

string

required

The URL of the order in the public tracking system

status

string

required

The status of the order

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations

Delivery Windows & Capacity

Jobs

Batch Jobs

Providers

Miscellaneous

Create Orders

Body

Response