ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2 to manage various shipping-related resources, including warehouses. Specifically, for the Warehouse - Update operation, it allows users to update details of an existing warehouse by providing its ID and the updated data in JSON format.

Common scenarios where this node is beneficial include:

  • Automating updates to warehouse information such as address, contact details, or operational parameters.
  • Synchronizing warehouse data between ShipStation and other systems.
  • Bulk updating warehouses as part of a larger workflow managing shipping logistics.

Practical example:

  • A user wants to update the address of a specific warehouse after relocation. They provide the warehouse ID and new address details in JSON, and the node sends the update request to ShipStation.

Properties

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

Output

The node outputs a JSON object representing the updated warehouse resource as returned by the ShipStation API. This includes all the warehouse's properties after the update has been applied.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "address": {
    "street1": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  },
  "phone": "string",
  "email": "string",
  // ... other warehouse properties
}

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:

    • Providing an invalid or non-existent warehouse ID will result in an error from the API.
    • Malformed JSON in the "JSON Data" property can cause parsing errors or API rejection.
    • Insufficient permissions or incorrect API credentials will lead to authentication errors.
  • Error messages:

    • Errors returned by the ShipStation API are handled and surfaced by the node. For example, if the warehouse ID does not exist, the API might return a 404 error.
    • If the JSON data is invalid, the node may throw a parsing error before sending the request.
  • Resolutions:

    • Verify the warehouse ID exists in ShipStation.
    • Ensure the JSON data is correctly formatted and matches the expected schema for warehouse updates.
    • Confirm that the API key credential is valid and has necessary permissions.

Links and References

Discussion