Sendcloud - Cancel Parcel
Description
Section titled “Description”This module cancels a previously created parcel in Sendcloud. It receives the parcel ID and makes a POST request to the /parcels/{parcel_id}/cancel endpoint. It is only possible to cancel parcels that have not yet been picked up by the carrier. If the cancellation is successful, it returns the parcel ID and the updated status.
Configuration
Section titled “Configuration”| Parameter | Type | Required | Description |
|---|---|---|---|
| credentials_id | credentials | Yes | Sendcloud credential (provider: sendcloud) |
| parcel_id | text | Yes | Parcel ID to cancel |
Credentials
Section titled “Credentials”A sendcloud type credential is required with the following fields:
- public_key: Sendcloud Public Key
- secret_key: Sendcloud Secret Key
Output
Section titled “Output”{ "success": true, "parcel_id": "12345", "status": "cancelled", "message": "Paquete 12345 cancelado exitosamente"}Usage Example
Section titled “Usage Example”Basic case
Section titled “Basic case”{ "credentials_id": "mi_credencial_sendcloud", "parcel_id": "12345"}API Used
Section titled “API Used”- Endpoint: POST
/parcels/{parcel_id}/cancel - Base: Sendcloud API (via helper
_sendcloudHelper) - Documentation: https://docs.sendcloud.sc/api/v2/
- Only parcels that have not yet been picked up by the carrier can be canceled
- The cancellation is performed via POST (not DELETE)
- Once canceled, the label is invalidated