ShipTownInstall

Overview

This node interacts with the ShipTown API to retrieve or create activity records. Specifically, for the Activity resource and the Get All operation, it fetches a list of all activities recorded in ShipTown. This is useful for workflows that need to monitor or analyze activity logs related to orders, shipments, or other tracked events within ShipTown.

Common scenarios include:

• Auditing recent activities for compliance or troubleshooting.
• Feeding activity data into dashboards or reports.
• Triggering downstream processes based on specific activity types.

For example, you might use this node to pull the latest 50 activities to review recent order processing events or to track user actions within your shipping system.

Properties

Output

The output is a JSON array where each item represents an activity object retrieved from the ShipTown API. Each activity object contains details such as log name, description, subject type, subject ID, timestamps, and any additional properties associated with the activity.

No binary data is returned by this operation.

Example output structure (simplified):

[
  {
    "id": 123,
    "log_name": "Order Shipped",
    "description": "Order #456 has been shipped",
    "subject_type": "order",
    "subject_id": 456,
    "properties": { ... },
    "created_at": "2024-01-01T12:00:00Z"
  },
  ...
]

Dependencies

• Requires an API key credential for authenticating with the ShipTown API.
• The node uses the base URL configured in the credentials to make HTTP requests.
• No additional external dependencies are needed beyond the ShipTown API access.

Troubleshooting

• Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
• Empty results: If no activities are returned, verify that there are activities logged in ShipTown and check if filters like limit or returnAll are set appropriately.
• Rate limits or API errors: The ShipTown API may enforce rate limits; handle errors gracefully and consider retry logic if needed.
• JSON parsing errors: When using additional fields with JSON input (not applicable here but relevant for other operations), ensure valid JSON syntax.

Links and References

• ShipTown API Documentation (for detailed API endpoints and data structures)
• n8n documentation on HTTP Request Authentication (general guidance on setting up API credentials)