Skip to main content
POST
/
v1
/
dispatch-and-manifest
Dispatch and Manifest Orders
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/dispatch-and-manifest \
  --header 'Authorization: Bearer <token>' \
  --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": "car",
      "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,
          "requirements": [
            "age_verification_on_delivery"
          ],
          "category": "<string>",
          "providerExternalId": "<string>",
          "subItems": [
            {
              "id": "abc-123",
              "description": "A box of books",
              "count": 2,
              "dimensions": {
                "depth": 14,
                "height": 10,
                "width": 12
              },
              "weight": 1.5,
              "valueCents": 1000,
              "requirements": [
                "age_verification_on_delivery"
              ],
              "category": "<string>",
              "providerExternalId": "<string>",
              "sku": "<string>",
              "substitution": {
                "preference": "<string>",
                "source": "<string>",
                "substituteItems": [
                  {
                    "id": "<string>",
                    "sku": "<string>",
                    "quantity": 123
                  }
                ]
              },
              "subItems": "<unknown>"
            }
          ]
        }
      ],
      "optimizationParameters": {
        "pickupDoorstepTimeSeconds": 90,
        "dropoffDoorstepTimeSeconds": 180,
        "costsByMetric": {
          "distance": 10,
          "weight": 200
        },
        "clusterLabel": "<string>",
        "mxLabel": "<string>",
        "assignmentPriority": 1,
        "sequencePriority": 249,
        "sequenceGroup": "<string>"
      },
      "pickupPayment": {
        "barcode": {
          "type": "CODE128",
          "value": "1234567890"
        },
        "providerCard": true
      },
      "reapplyAutomations": true,
      "maxDeliveryFeeCents": 123,
      "shippingDetails": {
        "providerId": "<string>",
        "shipmentId": "<string>",
        "providerConsignmentId": "<string>",
        "providerExternalId": "<string>",
        "serviceCode": "<string>",
        "speed": "same_day"
      }
    }
  ],
  "manifestDetails": {
    "chargeAccountId": "<string>",
    "subProvider": "<string>"
  }
}
'
{
  "manifests": [
    {
      "providerId": "<string>",
      "orderIds": [
        "<string>"
      ],
      "documents": [
        {
          "id": "<string>",
          "url": "<string>",
          "contentType": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create, dispatch, and manifest orders in a single request.

orders
ManifestOrderInput · object[]
required

Orders to create, dispatch, and manifest.

manifestDetails
ManifestDetails · object

Shared manifest-level attributes applied across all orders.

Response

OK

manifests
ManifestResultSerializer · object[]
required

List of manifest results grouped by provider and store location.