ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2, allowing users to manage various ShipStation resources such as shipments, labels, products, tags, and more. Specifically for the Tag resource with the Create operation, the node enables creating a new tag in ShipStation by sending custom JSON data representing the tag's properties.

Common scenarios where this node is beneficial include automating the creation of tags to categorize or label shipments, products, or orders within ShipStation workflows. For example, a user might create tags dynamically based on order status or customer type to streamline shipping processes or reporting.

Properties

Name Meaning
JSON Data JSON data for the Tag resource. This should contain the properties defining the new tag.

The "JSON Data" property expects a JSON object string that represents the tag details to be created in ShipStation.

Output

The node outputs an array of JSON objects, each containing the response data from the ShipStation API after creating the tag. The output JSON structure corresponds directly to the created tag's representation returned by the API.

Example output JSON (simplified):

{
  "id": 123,
  "name": "New Tag",
  "color": "#FF0000",
  "active": true
}

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the ShipStation API via an API key credential configured in n8n.
  • The node uses the ShipStation API v2 endpoints.
  • Proper API credentials must be set up in n8n under the ShipStation API credential type.

Troubleshooting

  • Invalid JSON Data: If the JSON provided in "JSON Data" is malformed or missing required fields, the API will return an error. Ensure the JSON is valid and matches the expected schema for a tag.
  • API Authentication Errors: If the API key credential is invalid or missing, authentication errors will occur. Verify the API key configuration in n8n.
  • Unknown Operation Error: If the operation or resource parameters are incorrect or unsupported, the node throws an "Unknown operation" error.
  • API Rate Limits or Network Issues: Temporary failures communicating with ShipStation may cause errors; retry or check network connectivity.

Errors returned by the ShipStation API are handled and surfaced clearly, allowing users to identify issues with their requests.

Links and References

Discussion