Skip to main content
Use this endpoint to permanently delete a pickup that has not yet been assigned to a courier. Deletion is a hard remove — the pickup record will no longer appear in your list or be retrievable by pickup number. If you only want to stop a pickup without removing its record, use POST /pickups/{pickupNumber}/cancel instead.
Only pickups with status new or pendingPickup can be deleted. Use POST /pickups/{pickupNumber}/cancel for pickups in any other state.

Authentication

All requests require a valid API key. Company account keys must also include the X-Merchant-Id header.
X-Merchant-Id accepts your businessAccountCode (8-digit), externalMerchantId, or MongoDB _id. Single-business keys do not require this header.

Path parameter

string
required
The 6-digit pickup number returned when the pickup was created (e.g. 482917).

Request body

This endpoint does not require a request body.

Example request

Response

A successful deletion returns HTTP 200.
boolean
true on success.
object
Confirmation that the pickup was deleted.

Error responses

Example error — deletion not allowed

If you are unsure of the current status, call GET /pickups/{pickupNumber} before attempting a delete. For pickups in active or completed states, use POST /pickups/{pickupNumber}/cancel.