ShipStation

Interact with ShipStation API v2

Actions32

Batch Actions
Carrier Actions
- Get
- List
Inventory Actions
- List
- Update
Label Actions
- Create
- Get
- List
- Void
Product Actions
Shipment Actions
Tag Actions
Warehouse Actions

Overview

This node integrates with the ShipStation API v2 to manage shipment-related data and other resources such as batches, carriers, inventory, labels, products, rates, tags, and warehouses. Specifically, for the Shipment - Get operation, it retrieves detailed information about a single shipment by its unique ID.

Typical use cases include:

Fetching shipment details to track order fulfillment status.
Integrating shipment data into workflows for reporting or notifications.
Automating logistics processes by retrieving shipment metadata.

For example, you might use this node to get the current status and tracking information of a shipment after an order is processed in your e-commerce system.

Properties

Name	Meaning
Resource	The type of resource to interact with. For this context, it is "Shipment".
Operation	The action to perform on the resource. Here, "Get" means retrieving a specific shipment's details.
ID	The unique identifier of the shipment to retrieve. This is required for the "Get" operation.

Output

The node outputs a JSON object containing the shipment data returned from the ShipStation API. The structure corresponds directly to the API response for a shipment resource, including fields such as shipment ID, status, carrier details, tracking number, shipping address, and other shipment metadata.

If the API returns an error, the node will throw an error unless configured to continue on failure, in which case the output JSON will contain an error field with the message.

No binary data output is produced by this operation.

Dependencies

Requires an API key credential for authenticating with the ShipStation API.
The node uses an internal ShipStation API service wrapper to make HTTP requests.
No additional environment variables are needed beyond the API credentials.

Troubleshooting

Common issues:
- Providing an invalid or non-existent shipment ID will result in an API error.
- Network connectivity problems can cause request failures.
- Insufficient permissions or incorrect API credentials will lead to authentication errors.
Error messages:
- Errors returned by the ShipStation API are caught and rethrown with descriptive messages.
- If the node is set to continue on fail, errors appear in the output JSON under the error property.
Resolution tips:
- Verify that the shipment ID is correct and exists in your ShipStation account.
- Check that the API credentials are valid and have appropriate access rights.
- Ensure stable network connectivity when running the workflow.