Skip to main content
POST
Cancel a pickup
OAuth2 scopes required: write:pickup. See Scopes for OAuth apps.
Use this endpoint to cancel a pickup that hasn’t taken place yet. The response contains the updated pickup.

How cancellation works

  • Carriers that support cancellation via their API: the pickup is canceled with the carrier during the request. If the carrier confirms, the response is 200 and the pickup has the status CANCELLED. If not, the response is 409 and the pickup has the status FAILED.
  • Carriers that Sendcloud Support handles cancellations for: Sendcloud Support cancels the pickup with the carrier on your behalf. The response is 202 and the pickup has the status CANCELLATION_REQUESTED. Once Support has handled the request, the status changes to CANCELLED, CANCELLATION_FAILED or CANCELLATION_REJECTED, which you can follow with the Retrieve a pickup endpoint.
  • Other carriers: the pickup can’t be canceled through Sendcloud. The response is 409.
A pickup can’t be canceled once its pickup time has started, or after the carrier’s cancellation deadline.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

id
integer
required

The id of the pickup you want to cancel.

Response

The carrier has canceled the pickup.

data
BRT Pickup Object · object