ShipTown icon

ShipTown

Consume ShipTown API
Join our community

Actions20

Overview

This node integrates with the ShipTown API to retrieve inventory movement data. Specifically, the "Get Movements" operation under the "Inventory" resource fetches records of inventory movements, which can include stock changes, transfers, or adjustments within warehouses.

Use cases for this node include:

  • Tracking inventory flow and changes over time.
  • Auditing stock movements for compliance or operational analysis.
  • Integrating inventory movement data into broader workflows such as reporting or alerting systems.

For example, a warehouse manager could use this node to automatically pull recent inventory movements and update a dashboard or trigger notifications when stock levels change significantly.

Properties

Name Meaning
Limit Max number of inventory movement results to return. Must be at least 1.
Return All Whether to return all available inventory movement results (true) or limit the results (false).

Output

The node outputs an array of JSON objects representing inventory movement records retrieved from the ShipTown API endpoint /api/inventory-movements. Each object contains details about a single inventory movement, such as item identifiers, quantities moved, timestamps, and related metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ShipTown API.
  • The base URL for the API is configured via credentials and must point to the correct ShipTown domain.
  • Network access to the ShipTown API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Authentication failures if the API key or domain is incorrect or missing.
    • Request limits exceeded if too many requests are made in a short period.
    • Empty results if no inventory movements exist or filters exclude all data.

  • Error messages:

    • Errors returned from the ShipTown API will be surfaced, typically including HTTP status codes and error messages.
    • If the node is set to continue on failure, errors are returned as JSON objects with an error field describing the issue.

  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Check the base URL domain setting in credentials.
    • Adjust the "Limit" property or enable "Return All" to control the volume of data requested.
    • Review API usage limits and ensure compliance with ShipTown's rate limiting policies.

Links and References

Discussion