EasyPost - Refund Shipment
Description
Section titled “Description”This module requests a refund for a previously purchased shipment in EasyPost. It receives the shipment ID and makes a POST request to the /shipments/{shipment_id}/refund endpoint. It returns the refund status and the updated shipment status.
Configuration
Section titled “Configuration”| Parameter | Type | Required | Description |
|---|---|---|---|
| credentials_id | credentials | Yes | EasyPost credential (provider: easypost) |
| shipment_id | text | Yes | Shipment ID to refund (shp_…) |
Credentials
Section titled “Credentials”A easypost type credential is required with the following fields:
- api_key: EasyPost API Key
Output
Section titled “Output”{ "success": true, "shipment_id": "shp_abc123", "refund_status": "submitted", "status": "refunded", "message": "Reembolso solicitado: submitted"}Usage Example
Section titled “Usage Example”Basic case
Section titled “Basic case”{ "credentials_id": "mi_credencial_easypost", "shipment_id": "shp_abc123"}API Used
Section titled “API Used”- Endpoint: POST
/shipments/{shipment_id}/refund - Base: EasyPost API (via helper
_easypostHelper) - Documentation: https://www.easypost.com/docs/api
- The refund can have different statuses: submitted, refunded, rejected
- USPS refunds are generally approved automatically if the label was not scanned
- Refund processing time depends on the carrier
- Only shipments that have been purchased but not delivered can be refunded