ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2 to manage warehouses and other resources. Specifically, for the Warehouse - List operation, it retrieves a list of warehouses from the ShipStation account.

Common scenarios where this node is useful include:

  • Synchronizing warehouse data from ShipStation into another system.
  • Displaying available warehouses for order fulfillment or inventory management.
  • Automating workflows that depend on warehouse information, such as routing shipments or updating stock levels.

For example, you might use this node to fetch all warehouses and then filter them based on location or capacity in subsequent workflow steps.

Properties

Name Meaning
Options Collection of options to control pagination and result limits:
  Page Page number to retrieve (default: 1)
  Page Size Number of items per page (default: 50)
  Return All Whether to return all results across all pages (true/false, default: false)

Output

The node outputs an array of JSON objects representing warehouses. Each item corresponds to a single warehouse resource retrieved from ShipStation.

The output structure under the json field contains the raw data returned by the ShipStation API for each warehouse, including typical warehouse properties such as ID, name, address, and other metadata.

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.
  • Pagination is handled internally, with support for fetching all pages if requested.
  • No additional environment variables are required beyond the API credentials.

Troubleshooting

  • API Errors: If the API returns an error (e.g., invalid credentials, rate limiting), the node will throw an error with details. Ensure your API key is valid and has sufficient permissions.
  • Pagination Limits: When Return All is set to true, the node fetches all pages automatically. For very large datasets, this may take time or hit API rate limits.
  • Invalid Parameters: Providing invalid page numbers or page sizes may cause errors or empty results.
  • Network Issues: Connectivity problems can cause request failures; verify network access to the ShipStation API endpoint.

If errors occur, check the error message for guidance and verify your input parameters and credentials.

Links and References

Discussion