ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

The node integrates with the ShipStation API v2, enabling automation of various shipping-related tasks. Specifically, for the Shipment - Cancel operation, it allows users to cancel an existing shipment by providing its ID. This is useful in scenarios where a shipment needs to be stopped due to order changes, errors, or customer requests.

Practical examples include:

  • Automatically canceling shipments when an order is canceled in an e-commerce platform.
  • Integrating with customer service workflows to halt shipments upon refund approvals.
  • Managing bulk shipment cancellations based on inventory or logistic constraints.

Properties

Name Meaning
ID The unique identifier of the shipment to be canceled. This is required to specify which shipment should be canceled.

Output

The node outputs a JSON object representing the response from the ShipStation API after attempting to cancel the shipment. This typically includes details about the canceled shipment or confirmation of the cancellation.

Example output structure (simplified):

{
  "shipmentId": "string",
  "status": "Canceled",
  "cancelDate": "ISO8601 timestamp",
  ...
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the ShipStation API.
  • The node depends on the ShipStation API v2 endpoint /v2/shipments/{id}/cancel.
  • No additional environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent shipment ID will result in an error from the API.
    • Network connectivity problems can cause request failures.
    • Insufficient permissions or invalid API credentials will prevent successful cancellation.

  • Error messages and resolutions:

    • "Unknown operation" — Ensure that the operation is set to "Cancel" and resource to "Shipment".
    • API error responses are handled and surfaced; check the error message for details such as "Shipment not found" or "Unauthorized".
    • To resolve authentication errors, verify that the API key credential is correctly configured and has necessary permissions.
    • For rate limiting or server errors, implement retry logic or check ShipStation service status.

Links and References

Discussion