Cancel Parcel

Cancel an outbound parcel before it has been delivered to the recipient.

Endpoint

POST /v2/parcels/cancel/{id}

Path Parameters

Parameter	Type	Required	Description
id	long	Yes	Unique identifier of the outbound parcel to cancel

:::caution Outbound Parcels Only Cancellation is only available for outbound parcels that have not yet been delivered. Attempting to cancel an already-delivered parcel or an inbound parcel will return an error. :::

Response

Returns a success boolean indicating whether the parcel was successfully cancelled.

{
  "success": true,
  "data": true
}

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/parcels/cancel/$ID" \
  -H "X-API-Key: $ECGRID_API_KEY"

C#

// .NET 10 — cancel an outbound parcel that has not yet been delivered
using System.Net.Http.Json;

var parcelId = 987654322L;

var response = await http.PostAsync(
    $"https://rest.ecgrid.io/v2/parcels/cancel/{parcelId}",
    null);
response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<bool>>();
if (result!.Data)
{
    Console.WriteLine($"Parcel {parcelId} successfully cancelled.");
}

Java

import java.net.URI;
import java.net.http.*;

String apiKey = System.getenv("ECGRID_API_KEY");
String id = "0"; // replace with actual id

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create(String.format("https://rest.ecgrid.io/v2/parcels/cancel/%s", id)))
    .header("X-API-Key", apiKey)
    .GET()
    .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = `https://rest.ecgrid.io/v2/parcels/cancel/${id}`;

const response = await fetch(url, {
  method: 'POST',
  headers: { 'X-API-Key': apiKey },
});

const data = await response.json();
console.log(data);

Python

import os, requests

api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
id = 0  # replace with actual id
url = f"https://rest.ecgrid.io/v2/parcels/cancel/{id}"

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

response.raise_for_status()
print(response.json())

See Also

• Upload Parcel — send a replacement parcel after cancellation
• Outbox List — verify parcel status before attempting cancellation
• Get Parcel — check current delivery status