curl --request DELETE \
--url https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation', 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://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "<string>",
"data": {
"id": "dlv_3f1a821cdb58498cbb52f4706545a089",
"environment": "live",
"simulated": true,
"status": "in_transit",
"recipient": {
"id": "rcp_3f1a821cdb58498cbb52f4706545a089",
"phone_number": "<string>",
"name": "<string>"
},
"pickup": {
"name": "<string>",
"contact": "<string>",
"address": "<string>",
"latitude": 0,
"longitude": 0
},
"dropoff": {
"id": "adr_78de60204f574a64be88ba9bd94a049f",
"address": "<string>",
"latitude": 123,
"longitude": 123,
"label": "<string>",
"municipality": "<string>",
"delivery_notes": "<string>"
},
"payment": {
"type": "cod",
"goods_value": 123
},
"vehicle_type": "bike",
"currency": "GHS",
"requires_custom_quote": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"reference": "H-RS83223",
"delivery_instructions": "<string>",
"delivery_fee": 1,
"tracking_url": "<string>",
"simulation": {
"scenario": "failed_then_retried",
"status": "running",
"step": 3,
"steps_total": 8,
"next_step_at": "2026-10-02T10:15:05Z"
}
}
}Stop an automatic simulation
Stops a running simulation and leaves the delivery at its current status, so you can continue with manual transitions. Calling it again, or on a delivery with no running simulation, returns the delivery unchanged. This endpoint is available only on the sandbox server and accepts only test keys.
curl --request DELETE \
--url https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation', 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://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.developer.haulstow.co/v1/test-helpers/deliveries/{delivery_id}/simulation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "<string>",
"data": {
"id": "dlv_3f1a821cdb58498cbb52f4706545a089",
"environment": "live",
"simulated": true,
"status": "in_transit",
"recipient": {
"id": "rcp_3f1a821cdb58498cbb52f4706545a089",
"phone_number": "<string>",
"name": "<string>"
},
"pickup": {
"name": "<string>",
"contact": "<string>",
"address": "<string>",
"latitude": 0,
"longitude": 0
},
"dropoff": {
"id": "adr_78de60204f574a64be88ba9bd94a049f",
"address": "<string>",
"latitude": 123,
"longitude": 123,
"label": "<string>",
"municipality": "<string>",
"delivery_notes": "<string>"
},
"payment": {
"type": "cod",
"goods_value": 123
},
"vehicle_type": "bike",
"currency": "GHS",
"requires_custom_quote": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"reference": "H-RS83223",
"delivery_instructions": "<string>",
"delivery_fee": 1,
"tracking_url": "<string>",
"simulation": {
"scenario": "failed_then_retried",
"status": "running",
"step": 3,
"steps_total": 8,
"next_step_at": "2026-10-02T10:15:05Z"
}
}
}Authorizations
A business-bound HaulStow API key. Send
Authorization: Bearer hsg_live_key_... to the live server or a
hsg_test_key_... key to the sandbox server. Never expose this key in a browser.
Headers
Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _,
-, or :. Invalid values are replaced. The accepted/generated value is
returned in the response.
1 - 128^[A-Za-z0-9._:-]+$Optional for naturally idempotent cancellation; recommended for a uniform mutation policy.
8 - 255Path Parameters
^dlv_[a-f0-9]{32}$"dlv_3f1a821cdb58498cbb52f4706545a089"
