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 shipments and other related resources such as batches, carriers, inventory, labels, products, rates, tags, and warehouses. Specifically for the Shipment resource's Update operation, it allows users to update an existing shipment by providing its ID and the updated data in JSON format.

Common scenarios where this node is beneficial include:

Automating shipment updates in response to changes in order details or shipping preferences.
Integrating shipment management into broader workflows that handle order processing and fulfillment.
Synchronizing shipment information between ShipStation and other systems.

For example, a user can update the shipping address or package details of a shipment by specifying the shipment ID and the new data in JSON format.

Properties

Name	Meaning
ID	The unique identifier of the shipment to update.
JSON Data	The JSON-formatted data containing the fields and values to update on the shipment.

Output

The node outputs a JSON object representing the updated shipment resource as returned by the ShipStation API. This includes all relevant shipment details after the update has been applied.

If an error occurs during the update, the output will contain an error message describing the issue (only if "Continue On Fail" is enabled).

No binary data output is produced by this operation.

Dependencies

Requires an API key credential for authenticating with the ShipStation API.
The node depends on the ShipStation API service being accessible and properly configured.
Pagination and error handling services are used internally but do not require additional user configuration.

Troubleshooting

Common issues:
- Providing an invalid or non-existent shipment ID will result in an error from the API.
- Malformed JSON in the "JSON Data" property can cause parsing errors or API rejection.
- Network connectivity problems or incorrect API credentials will prevent successful communication.
Error messages:
- Errors returned from the ShipStation API are caught and presented as node errors.
- If the node throws an "Unknown operation" error, verify that the operation and resource selections are correct.
- To handle errors gracefully, enable the "Continue On Fail" option to receive error details in the output instead of stopping execution.