Envia.com - Cancel Shipment

Description

This module cancels a previously created shipment in Envia.com. It receives the shipment ID and makes a POST request to the /ship/cancel/ endpoint with the shipment_id. If the cancellation is successful, it returns the shipment ID and the updated status.

Configuration

Parameter	Type	Required	Description
credentials_id	credentials	Yes	Envia.com credential (provider: envia)
shipment_id	text	Yes	Shipment ID to cancel

Credentials

A envia type credential is required with the following fields:

• api_key: Envia.com API Key

Output

{
  "success": true,
  "shipment_id": "12345",
  "status": "cancelled",
  "message": "Envio 12345 cancelado exitosamente"
}

Usage Example

Basic case

{
  "credentials_id": "mi_credencial_envia",
  "shipment_id": "12345"
}

API Used

• Endpoint: POST /ship/cancel/
• Base: Envia.com API (via helper _enviaHelper)
• Documentation: https://docs.envia.com/

Notes

• Only shipments that have not yet been picked up by the carrier can be canceled
• The cancellation is performed via POST (not DELETE) in the Envia.com API
• Cancellation policies depend on the selected carrier

Related Nodes

• Envia.com - Create Shipment / Label (enviaCreateShipment)
• Envia.com - Get Rates (enviaGetRates)
• Envia.com - Track Shipment (enviaGetTracking)
• Envia.com - List Carriers (enviaGetCarriers)