Create Orders

POST

orders

curl --request POST \
  --url https://api.sandbox.usenash.com/v1/orders \
  --header 'Content-Type: application/json' \
  --data '{
  "orders": [
    {
      "externalId": "<string>",
      "pickupAddress": "<string>",
      "pickupPlaceId": "<string>",
      "pickupPhoneNumber": "<string>",
      "pickupBusinessName": "<string>",
      "pickupFirstName": "<string>",
      "pickupLastName": "<string>",
      "pickupInstructions": "<string>",
      "pickupStoreLocationId": "<string>",
      "pickupExternalStoreLocationId": "<string>",
      "pickupStoreLocationIds": [
        "<string>"
      ],
      "pickupZoneIds": [
        "<string>"
      ],
      "pickupBarcodes": [
        "<string>"
      ],
      "pickupEmail": "<string>",
      "dropoffAddress": "<string>",
      "dropoffPlaceId": "<string>",
      "dropoffPhoneNumber": "<string>",
      "dropoffBusinessName": "<string>",
      "dropoffFirstName": "<string>",
      "dropoffLastName": "<string>",
      "dropoffInstructions": "<string>",
      "dropoffBarcodes": [
        "<string>"
      ],
      "dropoffEmail": "<string>",
      "deliveryMode": "<string>",
      "pickupStartTime": "2023-11-07T05:31:56Z",
      "pickupEndTime": "2023-11-07T05:31:56Z",
      "dropoffStartTime": "2023-11-07T05:31:56Z",
      "dropoffEndTime": "2023-11-07T05:31:56Z",
      "deliveryWindowId": "<string>",
      "description": "<string>",
      "itemsCount": 123,
      "currency": "<string>",
      "valueCents": 123,
      "tipAmountCents": 123,
      "requirements": [
        "photo_proof_of_delivery",
        "age_verification_on_delivery"
      ],
      "minimumVehicleSize": "<string>",
      "dispatchStrategyId": "<string>",
      "orderMetadata": {},
      "tags": [
        "<string>"
      ],
      "referenceId": "<string>",
      "pickupAddressNumber": "<string>",
      "pickupAddressSecondarynumber": "<string>",
      "pickupAddressFormattedStreet": "<string>",
      "pickupAddressCity": "<string>",
      "pickupAddressCounty": "<string>",
      "pickupAddressState": "<string>",
      "pickupAddressZip": "<string>",
      "pickupAddressCountry": "<string>",
      "pickupLat": 123,
      "pickupLng": 123,
      "dropoffAddressNumber": "<string>",
      "dropoffAddressSecondarynumber": "<string>",
      "dropoffAddressFormattedStreet": "<string>",
      "dropoffAddressCity": "<string>",
      "dropoffAddressCounty": "<string>",
      "dropoffAddressState": "<string>",
      "dropoffAddressZip": "<string>",
      "dropoffAddressCountry": "<string>",
      "dropoffLat": 123,
      "dropoffLng": 123,
      "weight": 123,
      "height": 123,
      "width": 123,
      "depth": 123,
      "items": [
        {
          "id": "abc-123",
          "description": "A box of books",
          "count": 2,
          "dimensions": {
            "depth": 14,
            "height": 10,
            "width": 12
          },
          "weight": 1.5,
          "valueCents": 1000,
          "subItems": [
            {}
          ]
        }
      ],
      "optimizationParameters": {
        "pickupDoorstepTimeSeconds": 90,
        "dropoffDoorstepTimeSeconds": 180,
        "costsByMetric": {
          "distance": 10,
          "weight": 200
        },
        "clusterLabel": "<string>",
        "assignmentPriority": 1,
        "sequencePriority": 249,
        "sequenceGroup": "<string>"
      }
    }
  ]
}'

[
  {
    "id": "ord_1234567890",
    "createdAt": "2023-08-29T19:17:46.264523",
    "externalId": "1234567890",
    "referenceId": "1234567890",
    "portalUrl": "https://portal.dev.usenash.com/orders/ord_1234567890",
    "publicTrackingUrl": "https://tracking.dev.usenash.com/ord_1234567890",
    "status": "needs_attention",
    "tags": [
      "quotes_only"
    ],
    "orderMetadata": {
      "key": "value"
    },
    "pickupAddress": "185 University Ave, Palo Alto, CA 94301",
    "pickupPlaceId": "ChIJd8BlQJq3t4kRUKhH43CQ",
    "pickupAddressNumber": "185",
    "pickupAddressSecondarynumber": "<string>",
    "pickupAddressFormattedStreet": "University Ave",
    "pickupAddressCity": "Palo Alto",
    "pickupAddressCounty": "Santa Clara",
    "pickupAddressState": "CA",
    "pickupAddressZip": "94301",
    "pickupAddressCountry": "US",
    "pickupLat": 37.422222,
    "pickupLng": -122.139776,
    "pickupPhoneNumber": "+15555555555",
    "pickupFirstName": "Manager",
    "pickupLastName": "Manager",
    "pickupBusinessName": "Store ABC",
    "pickupInstructions": "Leave at the front door",
    "pickupStoreLocationId": "stl_VwpoPJaaqWiPGnXEhWfX",
    "pickupExternalStoreLocationId": "0021112",
    "pickupZoneIds": [
      "<string>"
    ],
    "pickupBarcodes": [
      "1234567890",
      "0987654321"
    ],
    "dropoffAddress": "401 San Antonio Rd, Mountain View, CA 94040",
    "dropoffPlaceId": "ChIJd8BlQJq3t4kRUKhH43CQ",
    "dropoffAddressNumber": "401",
    "dropoffAddressSecondarynumber": "<string>",
    "dropoffAddressFormattedStreet": "San Antonio Rd",
    "dropoffAddressCity": "Mountain View",
    "dropoffAddressCounty": "Santa Clara",
    "dropoffAddressState": "CA",
    "dropoffAddressZip": "94040",
    "dropoffAddressCountry": "US",
    "dropoffLat": 37.422222,
    "dropoffLng": -122.139776,
    "dropoffPhoneNumber": "+15555555556",
    "dropoffFirstName": "Quote",
    "dropoffLastName": "Request",
    "dropoffBusinessName": "<string>",
    "dropoffInstructions": "Leave at the front door",
    "dropoffStoreLocationId": "<string>",
    "dropoffBarcodes": [
      "<string>"
    ],
    "deliveryMode": "scheduled",
    "pickupStartTime": "2024-08-22T23:54:08Z",
    "pickupEndTime": "2024-08-22T23:54:08Z",
    "dropoffStartTime": "2024-08-22T23:54:08Z",
    "dropoffEndTime": "2024-08-22T23:54:08Z",
    "description": "Order description",
    "itemsCount": "1",
    "requirements": [
      "photo_proof_of_delivery"
    ],
    "minimumVehicleSize": "car",
    "currency": "USD",
    "valueCents": "10000",
    "tipAmountCents": "1000",
    "width": "100",
    "depth": "100",
    "height": "100",
    "volume": "<string>",
    "weight": "100",
    "items": [
      {
        "id": "abc-123",
        "description": "A box of books",
        "count": 2,
        "dimensions": {
          "depth": 14,
          "height": 10,
          "width": 12
        },
        "weight": 1.5,
        "valueCents": 1000,
        "subItems": [
          {}
        ]
      }
    ],
    "dispatchStrategyId": "dss_1234567890",
    "documents": [
      {
        "contentType": "application/pdf",
        "data": "SGVsbG8gd29ybGQ=",
        "id": "doc_1234567890",
        "type": "shipping_label",
        "url": "https://example.com/document.pdf"
      }
    ],
    "validationErrors": {
      "pickupStartTime": "Time is in the past"
    },
    "quotes": [
      {
        "costSplitBusinessCents": null,
        "costSplitCustomerCents": null,
        "createdTime": "2024-09-03T20:43:45.899094",
        "currency": "USD",
        "dropoffEta": "2024-09-03T22:20:47.569000",
        "expireTime": "2024-09-03T21:43:45.899102",
        "id": "qot_2oWASjGxMtucwGgu6A7BYC",
        "insuranceFeeCents": 0,
        "nashFeeCents": 300,
        "pickupWindow": null,
        "priceCents": 100,
        "providerId": "dispatch_partner",
        "providerIsInternal": false,
        "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg",
        "providerName": "Dispatch",
        "tags": null,
        "taxAmountCents": null,
        "tollFeeCents": 0,
        "totalPriceBreakdown": {
          "priceCents": 100
        },
        "totalPriceCents": 100,
        "type": "LOCAL"
      }
    ],
    "failedQuotes": [
      "quote_1234567890",
      "quote_0987654321"
    ]
  }
]

Body

application/json

orders

object[]

required

List of orders to create

Order input for creating an order.

orders.externalId

string | null

Order unique identifier from an external system.

orders.pickupAddress

string | null

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

orders.pickupPlaceId

string | null

Google place id for the pickup location.

orders.pickupPhoneNumber

string | null

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

orders.pickupBusinessName

string | null

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

orders.pickupFirstName

string | null

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

orders.pickupLastName

string | null

Last 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.pickupStoreLocationId

string | null

A unique identifier for store location created in Nash.

orders.pickupExternalStoreLocationId

string | null

The external identifier used for your store.

orders.pickupStoreLocationIds

string[] | null

A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in pickupStoreLocationId and/or pickupStoreLocationExternalId.

orders.pickupZoneIds

string[] | null

A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.

orders.pickupBarcodes

string[] | null

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

orders.pickupEmail

string | null

The email of the contact at the pickup location.

orders.dropoffAddress

string | null

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

orders.dropoffPlaceId

string | null

Google place id for the dropoff location.

orders.dropoffPhoneNumber

string | null

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

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.dropoffFirstName

string | null

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

orders.dropoffLastName

string | null

Last 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.dropoffBarcodes

string[] | null

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

orders.dropoffEmail

string | null

The email of the contact at the dropoff location.

orders.deliveryMode

string | null

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

orders.pickupStartTime

string | null

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

orders.pickupEndTime

string | null

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

orders.dropoffStartTime

string | null

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

orders.dropoffEndTime

string | null

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

orders.deliveryWindowId

string | null

Delivery window id if using Nash delivery windows

orders.description

string | null

Order description and notes. Limited to 280 characters.

orders.itemsCount

integer | null

The number of items in this order

orders.currency

string | null

Local currency

orders.valueCents

Order value in cents

orders.tipAmountCents

integer | null

Tip paid to the driver in cents

orders.requirements

Package requirements.

Detailed description: https://docs.usenash.com/reference/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,

display_barcode_on_pickup

Example:

[
  "photo_proof_of_delivery",
  "age_verification_on_delivery"
]

orders.minimumVehicleSize

string | null

The requested minimum vehicle size.

orders.dispatchStrategyId

string | null

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

orders.orderMetadata

object | null

Key-value data to attach to this order.

orders.tags

string[] | null

Optional order tags, they will be included in every response

orders.referenceId

string | null

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

orders.pickupAddressNumber

string | null

The number on a house.

orders.pickupAddressSecondarynumber

string | null

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

orders.pickupAddressFormattedStreet

string | null

The street of the address.

orders.pickupAddressCity

string | null

The city of the pickup address.

orders.pickupAddressCounty

string | null

The county associated with the pickup address.

orders.pickupAddressState

string | null

The state of the pickup address.

orders.pickupAddressZip

string | null

The zip or postal code of the pickup address.

orders.pickupAddressCountry

string | null

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

orders.pickupLat

number | null

The pickup latitude coordinate.

orders.pickupLng

number | null

The pickup longitude coordinate.

orders.dropoffAddressNumber

string | null

The number on a house.

orders.dropoffAddressSecondarynumber

string | null

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

orders.dropoffAddressFormattedStreet

string | null

The street of the address.

orders.dropoffAddressCity

string | null

The city of the dropoff address.

orders.dropoffAddressCounty

string | null

The county associated with the dropoff address.

orders.dropoffAddressState

string | null

The state of the dropoff address.

orders.dropoffAddressZip

string | null

The zip or postal code of the dropoff address.

orders.dropoffAddressCountry

string | null

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

orders.dropoffLat

number | null

The dropoff latitude coordinate.

orders.dropoffLng

number | null

The dropoff longitude coordinate.

orders.weight

The total weight of the package in kilograms (kg)

orders.height

The total height of the package in centimeters (cm)

orders.width

The total width of the package in centimeters (cm)

orders.depth

The total depth of the package in centimeters (cm)

orders.items

object[] | null

Lists of items in the delivery

orders.items.id

string | null

The merchant ID of the item

Example:

"abc-123"

orders.items.description

string | null

The description of the item

Example:

"A box of books"

orders.items.count

integer

default:1

The quantity of the item

Example:

2

orders.items.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

orders.items.weight

The weight of the item in kilograms (kg)

Example:

1.5

orders.items.valueCents

integer | null

The value of the item in cents

Example:

1000

orders.items.subItems

object[] | null

The sub-items of the item

orders.items.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

orders.items.subItems.description

string | null

The description of the item

Example:

"A box of books"

orders.items.subItems.count

integer

default:1

The quantity of the item

Example:

2

orders.items.subItems.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

orders.items.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

orders.items.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

orders.items.subItems.subItems

object[] | null

The sub-items of the item

orders.items.subItems.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

orders.items.subItems.subItems.description

string | null

The description of the item

Example:

"A box of books"

orders.items.subItems.subItems.count

integer

default:1

The quantity of the item

Example:

2

orders.items.subItems.subItems.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

orders.items.subItems.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

orders.items.subItems.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

orders.items.subItems.subItems.subItems

object[] | null

The sub-items of the item

orders.optimizationParameters

object | null

Order-level optimization parameters

orders.optimizationParameters.pickupDoorstepTimeSeconds

integer | null

Length of time (in seconds) it take the courier at the pickup location's doorstep.

Example:

90

orders.optimizationParameters.dropoffDoorstepTimeSeconds

integer | null

Length of time (in seconds) it take the courier at the dropoff location's doorstep.

Example:

180

orders.optimizationParameters.costsByMetric

object | null

The cost metric to use for the order

Example:

{ "distance": 10, "weight": 200 }

orders.optimizationParameters.clusterLabel

string | null

The cluster label for the order

orders.optimizationParameters.assignmentPriority

integer | null

The assignment priority for the order

Required range: 0 <= x <= 3

orders.optimizationParameters.sequencePriority

integer | null

The sequence priority for the order

Required range: 0 <= x <= 499

orders.optimizationParameters.sequenceGroup

string | null

The sequence group for the order

Response

200

application/json

string

required

The id of the order

Example:

"ord_1234567890"

createdAt

string

required

The date and time when the order was created

Example:

"2023-08-29T19:17:46.264523"

portalUrl

string

required

The URL of the order in the Nash portal

Example:

"https://portal.dev.usenash.com/orders/ord_1234567890"

publicTrackingUrl

string

required

The URL of the order in the public tracking system

Example:

"https://tracking.dev.usenash.com/ord_1234567890"

status

string

required

The status of the order

Example:

"needs_attention"

tags

string[]

required

The tags of the order

Example:

["quotes_only"]

externalId

string | null

The external id of the order

Example:

"1234567890"

referenceId

string | null

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

Example:

"1234567890"

orderMetadata

object | null

Key-value data to attach to Nash Jobs.

Example:

{ "key": "value" }

pickupAddress

string | null

The pickup address of the order

Example:

"185 University Ave, Palo Alto, CA 94301"

pickupPlaceId

string | null

Google place id for the pickup location.

Example:

"ChIJd8BlQJq3t4kRUKhH43CQ"

pickupAddressNumber

string | null

The number on a house.

Example:

"185"

pickupAddressSecondarynumber

string | null

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

pickupAddressFormattedStreet

string | null

The street of the address.

Example:

"University Ave"

pickupAddressCity

string | null

The city of the pickup address.

Example:

"Palo Alto"

pickupAddressCounty

string | null

The county associated with the pickup address.

Example:

"Santa Clara"

pickupAddressState

string | null

The state of the pickup address.

Example:

"CA"

pickupAddressZip

string | null

The zip or postal code of the pickup address.

Example:

"94301"

pickupAddressCountry

string | null

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

Example:

"US"

pickupLat

number | null

The pickup latitude coordinate.

Example:

37.422222

pickupLng

number | null

The pickup longitude coordinate.

Example:

-122.139776

pickupPhoneNumber

string | null

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

Example:

"+15555555555"

pickupFirstName

string | null

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

Example:

"Manager"

pickupLastName

string | null

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

Example:

"Manager"

pickupBusinessName

string | null

Pickup business name at the origin.

Example:

"Store ABC"

pickupInstructions

string | null

Any special instructions for pickup.

Example:

"Leave at the front door"

pickupStoreLocationId

string | null

A unique identifier for store location created in Nash.

Example:

"stl_VwpoPJaaqWiPGnXEhWfX"

pickupExternalStoreLocationId

string | null

The external identifier used for your store.

Example:

"0021112"

pickupZoneIds

string[] | null

A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.

pickupBarcodes

string[] | null

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

Example:

["1234567890", "0987654321"]

dropoffAddress

string | null

The dropoff address of the order

Example:

"401 San Antonio Rd, Mountain View, CA 94040"

dropoffPlaceId

string | null

Google place id for the dropoff location.

Example:

"ChIJd8BlQJq3t4kRUKhH43CQ"

dropoffAddressNumber

string | null

The number on a house.

Example:

"401"

dropoffAddressSecondarynumber

string | null

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

dropoffAddressFormattedStreet

string | null

The street of the address.

Example:

"San Antonio Rd"

dropoffAddressCity

string | null

The city of the dropoff address.

Example:

"Mountain View"

dropoffAddressCounty

string | null

The county associated with the dropoff address.

Example:

"Santa Clara"

dropoffAddressState

string | null

The state of the dropoff address.

Example:

"CA"

dropoffAddressZip

string | null

The zip or postal code of the dropoff address.

Example:

"94040"

dropoffAddressCountry

string | null

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

Example:

"US"

dropoffLat

number | null

The dropoff latitude coordinate.

Example:

37.422222

dropoffLng

number | null

The dropoff longitude coordinate.

Example:

-122.139776

dropoffPhoneNumber

string | null

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

Example:

"+15555555556"

dropoffFirstName

string | null

First name of the contact at the destination.

Example:

"Quote"

dropoffLastName

string | null

Last name of the contact at the destination.

Example:

"Request"

dropoffBusinessName

string | null

Dropoff business name at the destination.

dropoffInstructions

string | null

Any special instructions for dropoff.

Example:

"Leave at the front door"

dropoffStoreLocationId

string | null

A unique identifier for store location created in Nash.

dropoffBarcodes

string[] | null

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

deliveryMode

string | null

The delivery mode of the order

Example:

"scheduled"

pickupStartTime

string | null

The start time of the pickup window.

Example:

"2024-08-22T23:54:08Z"

pickupEndTime

string | null

The end time of the pickup window.

Example:

"2024-08-22T23:54:08Z"

dropoffStartTime

string | null

The start time of the dropoff window.

Example:

"2024-08-22T23:54:08Z"

dropoffEndTime

string | null

The end time of the dropoff window.

Example:

"2024-08-22T23:54:08Z"

description

string | null

The description of the order

Example:

"Order description"

itemsCount

string | null

The number of items in the order

Example:

"1"

requirements

string[] | null

The requirements of the order

Example:

["photo_proof_of_delivery"]

minimumVehicleSize

string | null

The requested minimum vehicle size.

Example:

"car"

currency

string | null

The currency of the order

Example:

"USD"

valueCents

string | null

The value of the order in cents

Example:

"10000"

tipAmountCents

string | null

The tip amount of the order in cents

Example:

"1000"

width

string | null

The width of the order in cm

Example:

"100"

depth

string | null

The depth of the order in cm

Example:

"100"

height

string | null

The height of the order in cm

Example:

"100"

volume

string | null

The volume of the order in cm^3

weight

string | null

The weight of the order in kg

Example:

"100"

items

object[] | null

The items of the order

items.id

string | null

The merchant ID of the item

Example:

"abc-123"

items.description

string | null

The description of the item

Example:

"A box of books"

items.count

integer

default:1

The quantity of the item

Example:

2

items.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

items.weight

The weight of the item in kilograms (kg)

Example:

1.5

items.valueCents

integer | null

The value of the item in cents

Example:

1000

items.subItems

object[] | null

The sub-items of the item

items.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

items.subItems.description

string | null

The description of the item

Example:

"A box of books"

items.subItems.count

integer

default:1

The quantity of the item

Example:

2

items.subItems.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

items.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

items.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

items.subItems.subItems

object[] | null

The sub-items of the item

items.subItems.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

items.subItems.subItems.description

string | null

The description of the item

Example:

"A box of books"

items.subItems.subItems.count

integer

default:1

The quantity of the item

Example:

2

items.subItems.subItems.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

items.subItems.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

items.subItems.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

items.subItems.subItems.subItems

object[] | null

The sub-items of the item

items.subItems.subItems.subItems.id

string | null

The merchant ID of the item

Example:

"abc-123"

items.subItems.subItems.subItems.description

string | null

The description of the item

Example:

"A box of books"

items.subItems.subItems.subItems.count

integer

default:1

The quantity of the item

Example:

2

items.subItems.subItems.subItems.dimensions

object | null

The dimensions of the item

Example:

{ "depth": 14, "height": 10, "width": 12 }

items.subItems.subItems.subItems.weight

The weight of the item in kilograms (kg)

Example:

1.5

items.subItems.subItems.subItems.valueCents

integer | null

The value of the item in cents

Example:

1000

items.subItems.subItems.subItems.subItems

object[] | null

The sub-items of the item

dispatchStrategyId

string | null

The dispatch strategy id of the order

Example:

"dss_1234567890"

documents

object[] | null

The documents of the order

Document object returned by the API.

Example:

[
  {
    "contentType": "application/pdf",
    "data": "SGVsbG8gd29ybGQ=",
    "id": "doc_1234567890",
    "type": "shipping_label",
    "url": "https://example.com/document.pdf"
  }
]

validationErrors

object | null

The validation errors of the order

Example:

{ "pickupStartTime": "Time is in the past" }

quotes

object[] | null

The quotes of the order

Generic serializer for quotes used in many endpoints.

quotes.id

string

required

Quote ID

Example:

"qot_01234567890"

quotes.providerId

string

required

Provider ID

Example:

"uber_standard_mini_mart"

quotes.providerName

string

required

Provider name

Example:

"Nash"

quotes.createdTime

string

required

Created time

Example:

"2021-01-01T00:00:00Z"

quotes.priceCents

integer

required

Price in cents

Example:

1000

quotes.type

string | null

Quote type

quotes.providerLogo

string | null

Provider logo

Example:

"https://nash.com/logo.png"

quotes.providerIsInternal

boolean | null

Is the provider internal

quotes.expireTime

string | null

Expire time

Example:

"2021-01-01T00:00:00Z"

quotes.taxAmountCents

integer | null

Tax amount in cents

Example:

100

quotes.tollFeeCents

integer | null

Toll fee in cents

Example:

100

quotes.nashFeeCents

integer | null

Nash fee in cents

Example:

100

quotes.insuranceFeeCents

integer | null

Insurance fee in cents

Example:

100

quotes.currency

string | null

Currency

Example:

"USD"

quotes.pickupWindow

string | null

Pickup window

Example:

"2021-01-01T00:00:00Z"

quotes.dropoffEta

string | null

Dropoff ETA

Example:

"2021-01-01T00:00:00Z"

quotes.tags

string[] | null

Tags

Example:

["tag1", "tag2"]

quotes.costSplitCustomerCents

integer | null

Cost split customer in cents

Example:

100

quotes.costSplitBusinessCents

integer | null

Cost split business in cents

Example:

100

quotes.totalPriceBreakdown

object | null

Total price breakdown

Example:

{
  "subtotal": 1000,
  "tax": 100,
  "total": 1100
}

quotes.totalPriceCents

integer | null

Total price in cents

Example:

1000

quotes.price

number | null

Price

Example:

1000

quotes.isSuccessful

boolean | null

Is successful

Example:

true

quotes.errorMessage

string | null

Error message

Example:

"Error message"

Example:

[
  {
    "costSplitBusinessCents": null,
    "costSplitCustomerCents": null,
    "createdTime": "2024-09-03T20:43:45.899094",
    "currency": "USD",
    "dropoffEta": "2024-09-03T22:20:47.569000",
    "expireTime": "2024-09-03T21:43:45.899102",
    "id": "qot_2oWASjGxMtucwGgu6A7BYC",
    "insuranceFeeCents": 0,
    "nashFeeCents": 300,
    "pickupWindow": null,
    "priceCents": 100,
    "providerId": "dispatch_partner",
    "providerIsInternal": false,
    "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg",
    "providerName": "Dispatch",
    "tags": null,
    "taxAmountCents": null,
    "tollFeeCents": 0,
    "totalPriceBreakdown": { "priceCents": 100 },
    "totalPriceCents": 100,
    "type": "LOCAL"
  }
]

failedQuotes

string[] | null

The failed quotes of the order

Example:

["quote_1234567890", "quote_0987654321"]

Create Order Create or update order by external identifier

curl --request POST \
  --url https://api.sandbox.usenash.com/v1/orders \
  --header 'Content-Type: application/json' \
  --data '{
  "orders": [
    {
      "externalId": "<string>",
      "pickupAddress": "<string>",
      "pickupPlaceId": "<string>",
      "pickupPhoneNumber": "<string>",
      "pickupBusinessName": "<string>",
      "pickupFirstName": "<string>",
      "pickupLastName": "<string>",
      "pickupInstructions": "<string>",
      "pickupStoreLocationId": "<string>",
      "pickupExternalStoreLocationId": "<string>",
      "pickupStoreLocationIds": [
        "<string>"
      ],
      "pickupZoneIds": [
        "<string>"
      ],
      "pickupBarcodes": [
        "<string>"
      ],
      "pickupEmail": "<string>",
      "dropoffAddress": "<string>",
      "dropoffPlaceId": "<string>",
      "dropoffPhoneNumber": "<string>",
      "dropoffBusinessName": "<string>",
      "dropoffFirstName": "<string>",
      "dropoffLastName": "<string>",
      "dropoffInstructions": "<string>",
      "dropoffBarcodes": [
        "<string>"
      ],
      "dropoffEmail": "<string>",
      "deliveryMode": "<string>",
      "pickupStartTime": "2023-11-07T05:31:56Z",
      "pickupEndTime": "2023-11-07T05:31:56Z",
      "dropoffStartTime": "2023-11-07T05:31:56Z",
      "dropoffEndTime": "2023-11-07T05:31:56Z",
      "deliveryWindowId": "<string>",
      "description": "<string>",
      "itemsCount": 123,
      "currency": "<string>",
      "valueCents": 123,
      "tipAmountCents": 123,
      "requirements": [
        "photo_proof_of_delivery",
        "age_verification_on_delivery"
      ],
      "minimumVehicleSize": "<string>",
      "dispatchStrategyId": "<string>",
      "orderMetadata": {},
      "tags": [
        "<string>"
      ],
      "referenceId": "<string>",
      "pickupAddressNumber": "<string>",
      "pickupAddressSecondarynumber": "<string>",
      "pickupAddressFormattedStreet": "<string>",
      "pickupAddressCity": "<string>",
      "pickupAddressCounty": "<string>",
      "pickupAddressState": "<string>",
      "pickupAddressZip": "<string>",
      "pickupAddressCountry": "<string>",
      "pickupLat": 123,
      "pickupLng": 123,
      "dropoffAddressNumber": "<string>",
      "dropoffAddressSecondarynumber": "<string>",
      "dropoffAddressFormattedStreet": "<string>",
      "dropoffAddressCity": "<string>",
      "dropoffAddressCounty": "<string>",
      "dropoffAddressState": "<string>",
      "dropoffAddressZip": "<string>",
      "dropoffAddressCountry": "<string>",
      "dropoffLat": 123,
      "dropoffLng": 123,
      "weight": 123,
      "height": 123,
      "width": 123,
      "depth": 123,
      "items": [
        {
          "id": "abc-123",
          "description": "A box of books",
          "count": 2,
          "dimensions": {
            "depth": 14,
            "height": 10,
            "width": 12
          },
          "weight": 1.5,
          "valueCents": 1000,
          "subItems": [
            {}
          ]
        }
      ],
      "optimizationParameters": {
        "pickupDoorstepTimeSeconds": 90,
        "dropoffDoorstepTimeSeconds": 180,
        "costsByMetric": {
          "distance": 10,
          "weight": 200
        },
        "clusterLabel": "<string>",
        "assignmentPriority": 1,
        "sequencePriority": 249,
        "sequenceGroup": "<string>"
      }
    }
  ]
}'

[
  {
    "id": "ord_1234567890",
    "createdAt": "2023-08-29T19:17:46.264523",
    "externalId": "1234567890",
    "referenceId": "1234567890",
    "portalUrl": "https://portal.dev.usenash.com/orders/ord_1234567890",
    "publicTrackingUrl": "https://tracking.dev.usenash.com/ord_1234567890",
    "status": "needs_attention",
    "tags": [
      "quotes_only"
    ],
    "orderMetadata": {
      "key": "value"
    },
    "pickupAddress": "185 University Ave, Palo Alto, CA 94301",
    "pickupPlaceId": "ChIJd8BlQJq3t4kRUKhH43CQ",
    "pickupAddressNumber": "185",
    "pickupAddressSecondarynumber": "<string>",
    "pickupAddressFormattedStreet": "University Ave",
    "pickupAddressCity": "Palo Alto",
    "pickupAddressCounty": "Santa Clara",
    "pickupAddressState": "CA",
    "pickupAddressZip": "94301",
    "pickupAddressCountry": "US",
    "pickupLat": 37.422222,
    "pickupLng": -122.139776,
    "pickupPhoneNumber": "+15555555555",
    "pickupFirstName": "Manager",
    "pickupLastName": "Manager",
    "pickupBusinessName": "Store ABC",
    "pickupInstructions": "Leave at the front door",
    "pickupStoreLocationId": "stl_VwpoPJaaqWiPGnXEhWfX",
    "pickupExternalStoreLocationId": "0021112",
    "pickupZoneIds": [
      "<string>"
    ],
    "pickupBarcodes": [
      "1234567890",
      "0987654321"
    ],
    "dropoffAddress": "401 San Antonio Rd, Mountain View, CA 94040",
    "dropoffPlaceId": "ChIJd8BlQJq3t4kRUKhH43CQ",
    "dropoffAddressNumber": "401",
    "dropoffAddressSecondarynumber": "<string>",
    "dropoffAddressFormattedStreet": "San Antonio Rd",
    "dropoffAddressCity": "Mountain View",
    "dropoffAddressCounty": "Santa Clara",
    "dropoffAddressState": "CA",
    "dropoffAddressZip": "94040",
    "dropoffAddressCountry": "US",
    "dropoffLat": 37.422222,
    "dropoffLng": -122.139776,
    "dropoffPhoneNumber": "+15555555556",
    "dropoffFirstName": "Quote",
    "dropoffLastName": "Request",
    "dropoffBusinessName": "<string>",
    "dropoffInstructions": "Leave at the front door",
    "dropoffStoreLocationId": "<string>",
    "dropoffBarcodes": [
      "<string>"
    ],
    "deliveryMode": "scheduled",
    "pickupStartTime": "2024-08-22T23:54:08Z",
    "pickupEndTime": "2024-08-22T23:54:08Z",
    "dropoffStartTime": "2024-08-22T23:54:08Z",
    "dropoffEndTime": "2024-08-22T23:54:08Z",
    "description": "Order description",
    "itemsCount": "1",
    "requirements": [
      "photo_proof_of_delivery"
    ],
    "minimumVehicleSize": "car",
    "currency": "USD",
    "valueCents": "10000",
    "tipAmountCents": "1000",
    "width": "100",
    "depth": "100",
    "height": "100",
    "volume": "<string>",
    "weight": "100",
    "items": [
      {
        "id": "abc-123",
        "description": "A box of books",
        "count": 2,
        "dimensions": {
          "depth": 14,
          "height": 10,
          "width": 12
        },
        "weight": 1.5,
        "valueCents": 1000,
        "subItems": [
          {}
        ]
      }
    ],
    "dispatchStrategyId": "dss_1234567890",
    "documents": [
      {
        "contentType": "application/pdf",
        "data": "SGVsbG8gd29ybGQ=",
        "id": "doc_1234567890",
        "type": "shipping_label",
        "url": "https://example.com/document.pdf"
      }
    ],
    "validationErrors": {
      "pickupStartTime": "Time is in the past"
    },
    "quotes": [
      {
        "costSplitBusinessCents": null,
        "costSplitCustomerCents": null,
        "createdTime": "2024-09-03T20:43:45.899094",
        "currency": "USD",
        "dropoffEta": "2024-09-03T22:20:47.569000",
        "expireTime": "2024-09-03T21:43:45.899102",
        "id": "qot_2oWASjGxMtucwGgu6A7BYC",
        "insuranceFeeCents": 0,
        "nashFeeCents": 300,
        "pickupWindow": null,
        "priceCents": 100,
        "providerId": "dispatch_partner",
        "providerIsInternal": false,
        "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg",
        "providerName": "Dispatch",
        "tags": null,
        "taxAmountCents": null,
        "tollFeeCents": 0,
        "totalPriceBreakdown": {
          "priceCents": 100
        },
        "totalPriceCents": 100,
        "type": "LOCAL"
      }
    ],
    "failedQuotes": [
      "quote_1234567890",
      "quote_0987654321"
    ]
  }
]

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Miscellaneous

Create Orders

Body

Response