ShipTown icon

ShipTown

Consume ShipTown API
Join our community

Actions20

Overview

This node interacts with the ShipTown API to retrieve comments related to data collector records. Specifically, the "Get Comments" operation under the "Data Collector" resource fetches comments made on data collector entries. This is useful for scenarios where you want to monitor or analyze feedback, notes, or annotations associated with data collection activities in your logistics or shipping workflows.

Practical examples include:

  • Extracting all comments from data collector records to audit user inputs.
  • Aggregating feedback or remarks for quality control.
  • Integrating comment data into reporting dashboards or further processing pipelines.

Properties

Name Meaning
Limit Maximum number of comment results to return (minimum 1).
Return All Whether to return all available comments or limit the output to the specified "Limit".

Output

The node outputs a JSON array where each element represents a comment object retrieved from the ShipTown API's /api/data-collector/comments endpoint. Each comment object contains details about individual comments on data collector records.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating requests to the ShipTown API.
  • The base URL for API requests is configured via credentials and must point to the correct ShipTown domain.
  • The node uses HTTP GET requests to the ShipTown API endpoints.

Troubleshooting

  • Common issues:

    • Authentication failures if the API key or domain is misconfigured.
    • Request limits exceeded if "Return All" is set to false but the "Limit" is too low to capture needed data.
    • Network connectivity problems preventing access to the ShipTown API.

  • Error messages:

    • Errors returned by the API will be surfaced as error messages in the node output.
    • If the node is set to continue on failure, errors will appear as JSON objects with an error field describing the issue.

  • Resolutions:

    • Verify that the API key credential is valid and has necessary permissions.
    • Check the domain URL in credentials to ensure it matches the ShipTown API endpoint.
    • Adjust "Limit" or enable "Return All" to retrieve more data if partial results are returned.
    • Ensure network connectivity and firewall settings allow outbound HTTPS requests to the ShipTown API.

Links and References

Discussion