ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2, allowing users to manage various shipping-related resources such as shipments, labels, inventory, products, rates, batches, carriers, warehouses, and tags. Specifically for the Label resource with the Void operation, the node enables voiding (canceling) a shipping label by its ID.

Practical scenarios include:

  • Voiding a shipping label that was created in error or is no longer needed.
  • Automating label management workflows where invalid or unused labels must be canceled programmatically.
  • Integrating label voiding into broader shipment processing pipelines.

Properties

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

Output

The node outputs JSON data representing the response from the ShipStation API after attempting to void the label. The structure typically includes details about the voided label or confirmation of the void action. If an error occurs, the output will contain an error message describing the issue.

No binary data output is involved in this operation.

Example output JSON structure:

{
  "id": "string",
  "voided": true,
  "message": "Label successfully voided"
}

(Note: Actual fields depend on the ShipStation API response.)

Dependencies

  • Requires an API key credential for authenticating with the ShipStation API.
  • The node depends on the ShipStation API service endpoint /v2/labels/{id}/void to perform the void operation.
  • Proper network access to ShipStation's API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent label ID will result in an error.
    • Network connectivity problems can cause request failures.
    • Insufficient permissions or invalid API credentials will lead to authentication errors.

  • Error messages:

    • Errors returned by the ShipStation API are caught and presented as node errors.
    • Typical error messages might include "Label not found," "Unauthorized," or "Invalid request."

  • Resolution tips:

    • Verify the label ID is correct and exists in your ShipStation account.
    • Ensure the API key credential is valid and has appropriate permissions.
    • Check network connectivity and firewall settings.
    • Use the node’s "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion