ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node interacts with the ShipStation API v2 to manage tags among other resources. Specifically, for the Tag - List operation, it retrieves a list of tags from the ShipStation account. This is useful when you want to fetch and process all or a subset of tags used in your shipping workflows, for example, to synchronize tags with another system, generate reports, or automate tagging logic.

Typical use cases include:

  • Retrieving all tags to display or analyze them.
  • Fetching a specific page of tags when dealing with large tag collections.
  • Integrating tag data into downstream automation or reporting nodes.

Properties

Name Meaning
Options Collection of options to control pagination and result size:
  Page Page number to retrieve (default 1).
  Page Size Number of items per page (default 50).
  Return All Boolean flag to return all results across all pages instead of just one page.

Output

The output is an array of JSON objects representing tags retrieved from ShipStation. Each item corresponds to a tag object as returned by the ShipStation API.

  • The json field contains the tag data.
  • If "Return All" is enabled, the node aggregates all pages of tags into a single array.
  • Pagination parameters control how many tags are returned per execution if "Return All" is false.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ShipStation API.
  • The node uses the ShipStation API v2 endpoints.
  • No additional environment variables are required beyond the API credentials configured in n8n.

Troubleshooting

  • API Errors: If the ShipStation API returns an error (e.g., invalid credentials, rate limits), the node will throw an error with details. Ensure your API key is valid and has sufficient permissions.
  • Pagination Limits: When "Return All" is enabled, the node fetches multiple pages internally. Large datasets may take longer to process or hit API rate limits.
  • Invalid Parameters: Providing invalid page numbers or sizes may cause errors or empty results. Use sensible values (page ≥ 1, pageSize > 0).
  • Network Issues: Connectivity problems can cause request failures. Verify network access to ShipStation API endpoints.

Links and References

Discussion