Cancel a delivery

curl --request POST \
  --url https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel', 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://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel")

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

request = Net::HTTP::Post.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>"
  }
}

POST

deliveries

{delivery_id}

cancel

Cancel a delivery

curl --request POST \
  --url https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel', 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://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://developer.haulstow.co/v1/deliveries/{delivery_id}/cancel")

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

request = Net::HTTP::Post.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>"
  }
}

Authorizations

Authorization

string

header

required

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

X-Request-ID

string

Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _, -, or :. Invalid values are replaced. The accepted/generated value is returned in the response.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Idempotency-Key

string

Optional for naturally idempotent cancellation; recommended for a uniform mutation policy.

Required string length: 8 - 255

Path Parameters

delivery_id

string

required

Pattern: ^dlv_[a-f0-9]{32}$

Example:

"dlv_3f1a821cdb58498cbb52f4706545a089"

Response

Delivery cancelled or existing cancelled representation returned.

success

boolean

required

statusCode

enum<integer>

required

Available options:

200,

201

message

string

required

data

object

required

Show child attributes

⌘I

Get started

Core concepts

Endpoint reference

Cancel a delivery

Authorizations

Headers

Path Parameters

Response