SevenSenders - Cancel Shipment
Description
Section titled “Description”This module cancels a previously created shipment in SevenSenders. It receives the shipment ID and makes a DELETE request to the /shipments/{shipment_id} endpoint. If the cancellation is successful, it returns the shipment ID and the updated status.
Configuration
Section titled “Configuration”| Parameter | Type | Required | Description |
|---|---|---|---|
| credentials_id | credentials | Yes | SevenSenders credential (provider: sevensenders) |
| shipment_id | text | Yes | Shipment ID to cancel |
Credentials
Section titled “Credentials”A sevensenders type credential is required with the following fields:
- api_key: SevenSenders API Key
Output
Section titled “Output”{ "success": true, "shipment_id": "ss-12345", "status": "cancelled", "message": "Envio cancelado exitosamente: ss-12345"}Usage Example
Section titled “Usage Example”Basic case
Section titled “Basic case”{ "credentials_id": "mi_credencial_sevensenders", "shipment_id": "ss-12345"}API Used
Section titled “API Used”- Endpoint: DELETE
/shipments/{shipment_id} - Base: SevenSenders API (via helper
_sevensendersHelper) - Documentation: https://docs.sevensenders.com/
- Only shipments that have not yet been picked up by the carrier can be canceled
- The operation is irreversible
- The status may come from
result.statusorresult.data.status
Related Nodes
Section titled “Related Nodes”- SevenSenders - Create Shipment (sevensendersCreateShipment)
- SevenSenders - Get Carriers (sevensendersGetCarriers)
- SevenSenders - Track Shipment (sevensendersGetTracking)
- SevenSenders - Get Labels (sevensendersGetLabels)