Cancel a shipment before handoff

DELETE/v1/shipments/{shipment_id}Cancel a shipment before handoff

Parameters

shipment_idstringpathrequired

pattern ^shp_[a-z0-9]{20}$

Responses

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "request_id": "req_00000000000000000005",
  "status": 409,
  "title": "Synthetic resource state conflicts",
  "type": "https://parcel-events.example/problems/conflict"
}

Examples

shipment_idrequiredpath parameter

curl -X DELETE 'https://api.parcel-events.example/v1/shipments/string'

const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'DELETE' });
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'DELETE' });
console.log(await response.json());

import requests

response = requests.request("DELETE", "https://api.parcel-events.example/v1/shipments/string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "DELETE", "https://api.parcel-events.example/v1/shipments/string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/shipments/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/shipments/string"))
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/shipments/string")
request = Net::HTTPGenericRequest.new("DELETE", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.parcel-events.example/v1/shipments/string");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "request_id": "req_00000000000000000005",
  "status": 409,
  "title": "Synthetic resource state conflicts",
  "type": "https://parcel-events.example/problems/conflict"
}

Search documentation

Parameters

Responses

Documentation menu