ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2, allowing users to manage various shipping-related resources such as shipments, labels, products, warehouses, and more. Specifically, for the Warehouse - Get operation, it retrieves detailed information about a specific warehouse by its ID.

Common scenarios where this node is beneficial include:

  • Fetching details of a particular warehouse to verify its address or status.
  • Integrating warehouse data into automated workflows for inventory or order management.
  • Synchronizing warehouse information between ShipStation and other systems.

Example use case: A user wants to retrieve the details of a warehouse before creating a shipment from that location, ensuring the correct warehouse address and settings are used.

Properties

Name Meaning
ID The unique identifier of the warehouse resource to retrieve. This is required for operations like get, update, delete, etc.

Output

The node outputs a JSON object representing the warehouse data retrieved from ShipStation. The structure corresponds to the ShipStation API's warehouse object, typically including fields such as warehouse ID, name, address, contact details, and other metadata.

Example output (simplified):

{
  "warehouseId": 123,
  "name": "Main Warehouse",
  "address1": "123 Shipping Lane",
  "city": "Shipville",
  "state": "CA",
  "postalCode": "90210",
  "country": "US",
  "phone": "555-1234"
}

No binary data output is produced 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 external dependencies beyond the ShipStation API service integration.

Troubleshooting

  • Common issues:

    • Invalid or missing warehouse ID: Ensure the ID provided exists in ShipStation and is correctly formatted.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or API downtime: Check connectivity and ShipStation service status.

  • Error messages:

    • Errors returned from the API are handled and surfaced. For example, if the warehouse ID does not exist, the API may return a 404 error which will be shown in the node output.
    • If the node throws an "Unknown operation" error, confirm that the operation and resource parameters are set correctly.
    • JSON parsing errors can occur if the input JSON data is malformed (not applicable for the Get operation but relevant for create/update).

To resolve errors, verify input parameters, credentials, and network connectivity.

Links and References

Discussion