Actions33
Shipment → Cancel
AI-generatedOverview
This node operation cancels a shipment in the ShipStation system using the ShipStation API. It is useful for scenarios where a shipment needs to be stopped or reversed after it has been created but before it is processed or shipped. For example, if an order is canceled by a customer or an error is found in the shipment details, this operation can be used to cancel the shipment to prevent it from being shipped.
Use Case Examples
- Cancel a shipment by providing its shipment ID to stop the shipping process.
- Use in an automated workflow to cancel shipments based on certain conditions, such as payment failure or stock unavailability.
Properties
| Name | Meaning |
|---|---|
| ID | The ID of the shipment to be canceled. This is a required string input that identifies the specific shipment resource to cancel. |
Output
JSON
json- The JSON response from the ShipStation API after attempting to cancel the shipment. This typically includes details about the cancellation status or any errors.
Dependencies
- Requires an API key credential for authenticating with the ShipStation API.
Troubleshooting
- Common issues include providing an invalid or non-existent shipment ID, which will cause the API to return an error indicating the shipment could not be found.
- API authentication errors if the API key credential is missing or invalid.
- Network or connectivity issues preventing communication with the ShipStation API.
- Error messages from the API are handled and surfaced by the node; users should verify the shipment ID and API credentials if errors occur.
Links
- ShipStation API Documentation - Cancel a Shipment - Official ShipStation API documentation for the cancel shipment endpoint, detailing request and response formats.