Change the destination or recipient of an own Direct API shipment
curl --request PATCH \
--url https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"destination": {
"latitude": 24.775,
"longitude": 46.739
},
"recipient": {
"name": "Noura",
"mobile": 559876543
}
}
'import requests
url = "https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId}"
payload = {
"destination": {
"latitude": 24.775,
"longitude": 46.739
},
"recipient": {
"name": "Noura",
"mobile": 559876543
}
}
headers = {
"If-Match": "<if-match>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
destination: {latitude: 24.775, longitude: 46.739},
recipient: {name: 'Noura', mobile: 559876543}
})
};
fetch('https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId}', 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-test.drop-hub.com/api/v2/external/shipments/{shipmentId}",
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([
'destination' => [
'latitude' => 24.775,
'longitude' => 46.739
],
'recipient' => [
'name' => 'Noura',
'mobile' => 559876543
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$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-test.drop-hub.com/api/v2/external/shipments/{shipmentId}"
payload := strings.NewReader("{\n \"destination\": {\n \"latitude\": 24.775,\n \"longitude\": 46.739\n },\n \"recipient\": {\n \"name\": \"Noura\",\n \"mobile\": 559876543\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("If-Match", "<if-match>")
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-test.drop-hub.com/api/v2/external/shipments/{shipmentId}")
.header("If-Match", "<if-match>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"latitude\": 24.775,\n \"longitude\": 46.739\n },\n \"recipient\": {\n \"name\": \"Noura\",\n \"mobile\": 559876543\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["If-Match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"latitude\": 24.775,\n \"longitude\": 46.739\n },\n \"recipient\": {\n \"name\": \"Noura\",\n \"mobile\": 559876543\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"status": "CREATED",
"trackingUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"version": 1,
"codAmount": 1,
"deliveryFeeAmount": 1,
"deliveryFeeCurrency": "SAR",
"eta": {
"target": "PICKUP",
"estimatedArrivalAt": "2023-11-07T05:31:56Z",
"estimatedMinutes": 123,
"calculatedAt": "2023-11-07T05:31:56Z",
"distanceMetres": 123
},
"proofAvailable": true,
"proofType": "PHOTO",
"deliveredAt": "2023-11-07T05:31:56Z",
"failureReasonCode": "<string>",
"cancellationReasonCode": "<string>",
"driver": {
"firstName": "<string>",
"vehicleType": "MOTORCYCLE",
"vehiclePlate": "<string>"
}
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/authentication-required",
"title": "Authentication required",
"status": 401,
"detail": "Authentication is required for this resource.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "AUTHENTICATION_REQUIRED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}External Shipments
Change the destination or recipient of an own Direct API shipment
If-Match carries the shipment version from its ETag. A new destination is accepted before pickup (CREATED, ASSIGNED, NO_DRIVER_AVAILABLE) when it is inside the same coverage checkout serviceability applies and the merchant’s agreement prices the new route exactly as the frozen delivery fee; the fee is never restated. A new recipient is accepted until the shipment is delivered, failed or cancelled. The assigned driver keeps the assignment and sees the new destination; a shipment.updated webhook is sent. A new pickupWindow is accepted until a driver accepts the shipment and must fit the pickup location’s opening hours (422 PICKUP_OUTSIDE_OPERATING_HOURS); the price does not depend on it. Shipments that came from a store platform (Salla, Zid) are changed in that platform: 409 SHIPMENT_CHANGE_NOT_SUPPORTED. Other refusals: 412 PRECONDITION_FAILED (stale If-Match), 409 SHIPMENT_CHANGE_NOT_ALLOWED (state), 409 SHIPMENT_PRICE_WOULD_CHANGE, 422 OUTSIDE_MERCHANT_COVERAGE or NO_PROVIDER_AVAILABLE, 422 SHIPMENT_VALIDATION_FAILED (nothing to change).
PATCH
/
api
/
v2
/
external
/
shipments
/
{shipmentId}
Change the destination or recipient of an own Direct API shipment
curl --request PATCH \
--url https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"destination": {
"latitude": 24.775,
"longitude": 46.739
},
"recipient": {
"name": "Noura",
"mobile": 559876543
}
}
'import requests
url = "https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId}"
payload = {
"destination": {
"latitude": 24.775,
"longitude": 46.739
},
"recipient": {
"name": "Noura",
"mobile": 559876543
}
}
headers = {
"If-Match": "<if-match>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
destination: {latitude: 24.775, longitude: 46.739},
recipient: {name: 'Noura', mobile: 559876543}
})
};
fetch('https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId}', 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-test.drop-hub.com/api/v2/external/shipments/{shipmentId}",
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([
'destination' => [
'latitude' => 24.775,
'longitude' => 46.739
],
'recipient' => [
'name' => 'Noura',
'mobile' => 559876543
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$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-test.drop-hub.com/api/v2/external/shipments/{shipmentId}"
payload := strings.NewReader("{\n \"destination\": {\n \"latitude\": 24.775,\n \"longitude\": 46.739\n },\n \"recipient\": {\n \"name\": \"Noura\",\n \"mobile\": 559876543\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("If-Match", "<if-match>")
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-test.drop-hub.com/api/v2/external/shipments/{shipmentId}")
.header("If-Match", "<if-match>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"latitude\": 24.775,\n \"longitude\": 46.739\n },\n \"recipient\": {\n \"name\": \"Noura\",\n \"mobile\": 559876543\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-test.drop-hub.com/api/v2/external/shipments/{shipmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["If-Match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"latitude\": 24.775,\n \"longitude\": 46.739\n },\n \"recipient\": {\n \"name\": \"Noura\",\n \"mobile\": 559876543\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"status": "CREATED",
"trackingUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"version": 1,
"codAmount": 1,
"deliveryFeeAmount": 1,
"deliveryFeeCurrency": "SAR",
"eta": {
"target": "PICKUP",
"estimatedArrivalAt": "2023-11-07T05:31:56Z",
"estimatedMinutes": 123,
"calculatedAt": "2023-11-07T05:31:56Z",
"distanceMetres": 123
},
"proofAvailable": true,
"proofType": "PHOTO",
"deliveredAt": "2023-11-07T05:31:56Z",
"failureReasonCode": "<string>",
"cancellationReasonCode": "<string>",
"driver": {
"firstName": "<string>",
"vehicleType": "MOTORCYCLE",
"vehiclePlate": "<string>"
}
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/authentication-required",
"title": "Authentication required",
"status": 401,
"detail": "Authentication is required for this resource.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "AUTHENTICATION_REQUIRED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}{
"type": "https://api.drophub.example/problems/access-denied",
"title": "Access denied",
"status": 403,
"detail": "Access to this resource is denied.",
"instance": "/api/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
"code": "ACCESS_DENIED",
"timestamp": "2026-08-22T18:30:00Z",
"correlationId": "018f2d8a-1f00-7000-8000-000000000207",
"requestId": "018f2d8a-1f00-7000-8000-000000000208"
}Authorizations
OAuth 2.0 client-credentials flow for external machine-to-machine integrations.
Headers
Example:
"\"3\""
Path Parameters
Body
application/json
Response
Minimal partner-safe shipment
ASSIGNED covers an offer awaiting the driver's acceptance and an accepted one. NO_DRIVER_AVAILABLE means the bounded driver search ended without a driver; the shipment can still be cancelled.
Available options:
CREATED, ASSIGNED, PICKED_UP, OUT_FOR_DELIVERY, DELIVERED, FAILED, NO_DRIVER_AVAILABLE, CANCELLED Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Example:
"SAR"
Show child attributes
Show child attributes
Available options:
PHOTO, SIGNATURE, null The driver who accepted the shipment, while it is still moving. Phone number, surname, licence and identifiers are not disclosed; contact goes through the shipment conversation.
Show child attributes
Show child attributes