Cancel a Pickup — POST /pickups/{pickupNumber}/cancel

Use this endpoint to cancel a scheduled pickup before the courier arrives. Cancellation eligibility depends on the pickup’s current status — if the pickup has progressed past a cancellable state, the API returns an error with the current status in the response details. You receive the pickupNumber in the response of POST /pickups.

If you want to permanently remove a pickup that is still in new or pendingPickup status, use DELETE /pickups/{pickupNumber} instead.

Authentication

All requests require a valid API key. Company account keys must also include the X-Merchant-Id header.

Authorization: Bearer nsk_live_YOUR_KEY
X-Merchant-Id: shop_123

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

curl -X POST "https://now.com.eg/api/public/v1/pickups/482917/cancel" \
  -H "Authorization: Bearer nsk_live_YOUR_KEY" \
  -H "X-Merchant-Id: shop_123"

Response

A successful cancellation returns HTTP 200.

boolean

true on success.

object

Confirmation details, including the updated pickup status.

{
  "success": true,
  "data": {
    "message": "Pickup cancelled successfully.",
    "pickupNumber": "482917"
  }
}

Error responses

HTTP status	Error code	Description
`400`	`VALIDATION_ERROR`	The pickup cannot be cancelled from its current status. The error `details` object includes `currentStatus`.
`404`	`NOT_FOUND`	No pickup with this `pickupNumber` found under your account.
`401`	`UNAUTHORIZED`	Missing or invalid API key.
`403`	`MERCHANT_REQUIRED`	Company key used without `X-Merchant-Id`.
`403`	`MERCHANT_NOT_FOUND`	The merchant in `X-Merchant-Id` is not linked to your company.

Example error — not cancellable

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "This pickup cannot be canceled from its current status.",
    "details": {
      "currentStatus": "pickedUp"
    }
  }
}

Before cancelling, call GET /pickups/{pickupNumber} to confirm the current status. If the pickup is still in new or pendingPickup and you want to remove it entirely, DELETE /pickups/{pickupNumber} is the cleaner option.

System

Merchants

Fees

Orders

Pickups

Reference

Cancel a Pickup — POST /pickups/{pickupNumber}/cancel

Authentication

Path parameter

Request body

Example request

Response

Error responses

Example error — not cancellable

​Authentication

​Path parameter

​Request body

​Example request

​Response

​Error responses

​Example error — not cancellable

Authentication

Path parameter

Request body

Example request

Response

Error responses

Example error — not cancellable