Skip to main content
PATCH
/
v1
/
fleet
/
deliveries
Bulk Update Deliveries
curl --request PATCH \
  --url https://api.sandbox.usenash.com/v1/fleet/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveries": [
    {
      "deliveryId": "<string>",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      },
      "proofOfDelivery": [
        {
          "imageUrl": "<string>"
        }
      ],
      "courier": {
        "name": "<string>",
        "phoneNumber": "<string>",
        "pickupPhoneNumber": "<string>",
        "dropoffPhoneNumber": "<string>",
        "profileImageUrl": "<string>",
        "vehicle": {
          "make": "<string>",
          "model": "<string>",
          "color": "<string>",
          "licensePlate": "<string>"
        },
        "externalId": "<string>"
      },
      "failure": {
        "reason": "<string>"
      },
      "pickupNote": "<string>",
      "dropoffNote": "<string>",
      "parkingLocation": "<string>",
      "returnParkingLocation": "<string>",
      "pickupEta": "2023-11-07T05:31:56Z",
      "dropoffEta": "2023-11-07T05:31:56Z",
      "externalDeliveryId": "<string>"
    }
  ]
}
'
import requests

url = "https://api.sandbox.usenash.com/v1/fleet/deliveries"

payload = { "deliveries": [
        {
            "deliveryId": "<string>",
            "coordinates": {
                "latitude": 0,
                "longitude": 0
            },
            "proofOfDelivery": [{ "imageUrl": "<string>" }],
            "courier": {
                "name": "<string>",
                "phoneNumber": "<string>",
                "pickupPhoneNumber": "<string>",
                "dropoffPhoneNumber": "<string>",
                "profileImageUrl": "<string>",
                "vehicle": {
                    "make": "<string>",
                    "model": "<string>",
                    "color": "<string>",
                    "licensePlate": "<string>"
                },
                "externalId": "<string>"
            },
            "failure": { "reason": "<string>" },
            "pickupNote": "<string>",
            "dropoffNote": "<string>",
            "parkingLocation": "<string>",
            "returnParkingLocation": "<string>",
            "pickupEta": "2023-11-07T05:31:56Z",
            "dropoffEta": "2023-11-07T05:31:56Z",
            "externalDeliveryId": "<string>"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deliveries: [
      {
        deliveryId: '<string>',
        coordinates: {latitude: 0, longitude: 0},
        proofOfDelivery: [{imageUrl: '<string>'}],
        courier: {
          name: '<string>',
          phoneNumber: '<string>',
          pickupPhoneNumber: '<string>',
          dropoffPhoneNumber: '<string>',
          profileImageUrl: '<string>',
          vehicle: {
            make: '<string>',
            model: '<string>',
            color: '<string>',
            licensePlate: '<string>'
          },
          externalId: '<string>'
        },
        failure: {reason: '<string>'},
        pickupNote: '<string>',
        dropoffNote: '<string>',
        parkingLocation: '<string>',
        returnParkingLocation: '<string>',
        pickupEta: '2023-11-07T05:31:56Z',
        dropoffEta: '2023-11-07T05:31:56Z',
        externalDeliveryId: '<string>'
      }
    ]
  })
};

fetch('https://api.sandbox.usenash.com/v1/fleet/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.usenash.com/v1/fleet/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'deliveries' => [
        [
                'deliveryId' => '<string>',
                'coordinates' => [
                                'latitude' => 0,
                                'longitude' => 0
                ],
                'proofOfDelivery' => [
                                [
                                                                'imageUrl' => '<string>'
                                ]
                ],
                'courier' => [
                                'name' => '<string>',
                                'phoneNumber' => '<string>',
                                'pickupPhoneNumber' => '<string>',
                                'dropoffPhoneNumber' => '<string>',
                                'profileImageUrl' => '<string>',
                                'vehicle' => [
                                                                'make' => '<string>',
                                                                'model' => '<string>',
                                                                'color' => '<string>',
                                                                'licensePlate' => '<string>'
                                ],
                                'externalId' => '<string>'
                ],
                'failure' => [
                                'reason' => '<string>'
                ],
                'pickupNote' => '<string>',
                'dropoffNote' => '<string>',
                'parkingLocation' => '<string>',
                'returnParkingLocation' => '<string>',
                'pickupEta' => '2023-11-07T05:31:56Z',
                'dropoffEta' => '2023-11-07T05:31:56Z',
                'externalDeliveryId' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.usenash.com/v1/fleet/deliveries"

	payload := strings.NewReader("{\n  \"deliveries\": [\n    {\n      \"deliveryId\": \"<string>\",\n      \"coordinates\": {\n        \"latitude\": 0,\n        \"longitude\": 0\n      },\n      \"proofOfDelivery\": [\n        {\n          \"imageUrl\": \"<string>\"\n        }\n      ],\n      \"courier\": {\n        \"name\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"pickupPhoneNumber\": \"<string>\",\n        \"dropoffPhoneNumber\": \"<string>\",\n        \"profileImageUrl\": \"<string>\",\n        \"vehicle\": {\n          \"make\": \"<string>\",\n          \"model\": \"<string>\",\n          \"color\": \"<string>\",\n          \"licensePlate\": \"<string>\"\n        },\n        \"externalId\": \"<string>\"\n      },\n      \"failure\": {\n        \"reason\": \"<string>\"\n      },\n      \"pickupNote\": \"<string>\",\n      \"dropoffNote\": \"<string>\",\n      \"parkingLocation\": \"<string>\",\n      \"returnParkingLocation\": \"<string>\",\n      \"pickupEta\": \"2023-11-07T05:31:56Z\",\n      \"dropoffEta\": \"2023-11-07T05:31:56Z\",\n      \"externalDeliveryId\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.sandbox.usenash.com/v1/fleet/deliveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deliveries\": [\n    {\n      \"deliveryId\": \"<string>\",\n      \"coordinates\": {\n        \"latitude\": 0,\n        \"longitude\": 0\n      },\n      \"proofOfDelivery\": [\n        {\n          \"imageUrl\": \"<string>\"\n        }\n      ],\n      \"courier\": {\n        \"name\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"pickupPhoneNumber\": \"<string>\",\n        \"dropoffPhoneNumber\": \"<string>\",\n        \"profileImageUrl\": \"<string>\",\n        \"vehicle\": {\n          \"make\": \"<string>\",\n          \"model\": \"<string>\",\n          \"color\": \"<string>\",\n          \"licensePlate\": \"<string>\"\n        },\n        \"externalId\": \"<string>\"\n      },\n      \"failure\": {\n        \"reason\": \"<string>\"\n      },\n      \"pickupNote\": \"<string>\",\n      \"dropoffNote\": \"<string>\",\n      \"parkingLocation\": \"<string>\",\n      \"returnParkingLocation\": \"<string>\",\n      \"pickupEta\": \"2023-11-07T05:31:56Z\",\n      \"dropoffEta\": \"2023-11-07T05:31:56Z\",\n      \"externalDeliveryId\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.usenash.com/v1/fleet/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deliveries\": [\n    {\n      \"deliveryId\": \"<string>\",\n      \"coordinates\": {\n        \"latitude\": 0,\n        \"longitude\": 0\n      },\n      \"proofOfDelivery\": [\n        {\n          \"imageUrl\": \"<string>\"\n        }\n      ],\n      \"courier\": {\n        \"name\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"pickupPhoneNumber\": \"<string>\",\n        \"dropoffPhoneNumber\": \"<string>\",\n        \"profileImageUrl\": \"<string>\",\n        \"vehicle\": {\n          \"make\": \"<string>\",\n          \"model\": \"<string>\",\n          \"color\": \"<string>\",\n          \"licensePlate\": \"<string>\"\n        },\n        \"externalId\": \"<string>\"\n      },\n      \"failure\": {\n        \"reason\": \"<string>\"\n      },\n      \"pickupNote\": \"<string>\",\n      \"dropoffNote\": \"<string>\",\n      \"parkingLocation\": \"<string>\",\n      \"returnParkingLocation\": \"<string>\",\n      \"pickupEta\": \"2023-11-07T05:31:56Z\",\n      \"dropoffEta\": \"2023-11-07T05:31:56Z\",\n      \"externalDeliveryId\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "deliveryId": "<string>",
      "success": true,
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "delivery": {}
    }
  ]
}
[
  {
    "error": {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    },
    "response_status": "<string>",
    "RequestID": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Top-level body for PATCH /v1/deliveries (bulk update).

​
deliveries
BulkDeliveryUpdateItem · object[]
required

Delivery updates to apply (max 100).

Required array length: 1 - 100 elements

Response

OK

Top-level response for PATCH /v1/deliveries.

​
results
BulkDeliveryUpdateResultItem · object[]
required

One result per request item, in order.