Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node integrates with the Shippo API to create a refund for a specific transaction. It is useful in e-commerce or shipping workflows where you need to programmatically issue refunds for shipments or transactions processed through Shippo. For example, after a customer cancels an order or a shipment fails, this node can automate the refund process by creating a refund request via the Shippo API.

Properties

Name Meaning
SHIPPO API VERSION Optional string to specify a non-default Shippo API version to use. Useful if you want to target a specific API version.
Async Boolean flag indicating whether the refund creation should be processed asynchronously (true) or synchronously (false).
Transaction The unique identifier of the transaction for which the refund is being created. This is required to specify the refund target.

Output

The node outputs JSON data representing the response from the Shippo API after attempting to create the refund. This typically includes details about the refund status, refund ID, and related transaction information. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Shippo API.
  • The node sends requests to https://api.goshippo.com.
  • Optionally supports specifying a custom API version via a header.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:
    • Missing or invalid API key will cause authentication errors.
    • Providing an incorrect or non-existent transaction ID will result in errors from the Shippo API.
    • If asynchronous processing is enabled but the system expects immediate confirmation, it may cause confusion about refund status.
  • Error messages:
    • Authentication failures usually indicate problems with the API key; verify that the correct key is configured.
    • Validation errors from the API often mean required fields like the transaction ID are missing or malformed.
    • Network or connectivity errors suggest checking internet access or Shippo service status.

Links and References

Discussion