An Order represents the delivery details for package(s) in the real world. It’s the most flexible way to initiate deliveries in Nash.

Orders enable you to:

  • Update the delivery details before a delivery is created (contact details, addresses, times, and requirements) e.g. E-Commerce Checkout Experience
  • Understand whether the order meets the criteria to become a delivery (validation) e.g. Error handling as early as possible
  • Batch orders through Nash Platform (not optimized or batched on your end) e.g. Optimizing catering routes
When one or more Orders are dispatched, they become a Job.

​
Order Data Model

Order status

  • needs_attention: The order requires attention due to some data issues (e.g. invalid address)
  • valid: The order is valid and is ready to be dispatched to a Nash Job & Delivery.
  • dispatched: The associated Nash job is found in order_metadata or by clicking on the action “view dispatched job”
  • archived: The order has been archived and is moved to archived tab in the Nash portal.

Note: All timestamps are in UTC and in this format %Y-%m-%dT%H:%M:%S.%f

{
  "id": "ord_PewiSWzxmCFPzW62Ry3A6V",
  "createdAt": "2024-01-25T21:10:43.722214",
  "externalId": null,
  "externalGroupId": null,
  "referenceId": null,
  "portalUrl": "https://portal.dev.usenash.com/orders/ord_PewiSWzxmCFPzW62Ry3A6V",
  "publicTrackingUrl": "https://tracking.dev.usenash.com/ord_PewiSWzxmCFPzW62Ry3A6V",
  "status": "valid",
  "tags": null,
  "orderMetadata": null,
  "pickupAddress": null,
  "pickupPhoneNumber": "+15005550005",
  "pickupFirstName": "pickupFName",
  "pickupLastName": "pickupLName",
  "pickupBusinessName": "pickupBusinessName",
  "pickupInstructions": "new pickup Instructions111",
  "pickupBarcodes": null,
  "dropoffAddress": "401 San Antonio Rd, Mountain View, CA 94040",
  "dropoffPhoneNumber": "+15005550006",
  "dropoffFirstName": "dropoffLName",
  "dropoffLastName": "dropoffFtName",
  "dropoffBusinessName": "dropoffBusinessName",
  "dropoffInstructions": "1) Arrive at Ferrari North America building, 250 Sylvan Ave: Driver can park in visitors or any open spots in the font of the building.",
  "dropoffBarcodes": null,
  "deliveryMode": "now",
  "pickupStartTime": null,
  "pickupEndTime": null,
  "dropoffStartTime": null,
  "dropoffEndTime": null,
  "description": "Test package description",
  "itemsCount": null,
  "requirements": ["photo_proof_of_delivery"],
  "minimumVehicleSize": null,
  "currency": null,
  "documents": [
    {
      "id": "doc_ELre5GCELQ6w3UHKAgbm6F",
      "type": "SHIPPING_LABEL",
      "url": "https://nash-documents-dev.s3-us-west-1.amazonaws.com/dlv_bR7NWwhWSQRohyjs7UZd7D_fEavuZda787M70sJEhtCAA==.png",
      "data": null,
      "contentType": "image/png"
    },
    {
      "id": "doc_nuKEL5W8mMgnXuRrFqwwsc",
      "type": "PICKUP_LABEL",
      "url": "https://nash-documents-dev.s3-us-west-1.amazonaws.com/dlv_bR7NWwhWSQRohyjs7UZd7D_QPiARbKwfJRkC94KVQrT8w==.png",
      "data": null,
      "contentType": "image/png"
    }
  ],
  "valueCents": "5000",
  "tipAmountCents": "100",
  "width": null,
  "depth": null,
  "height": null,
  "volume": null,
  "weight": null,
  "dispatchStrategyId": null,
  "validationErrors": {}
}
Nash APIOrder Address Validation (Geocoding)