Actions20
Overview
This node integrates with the ShipTown API to manage various resources including users, orders, products, inventory, activities, warehouses, and data collectors. Specifically for the User resource with the Get All operation, it retrieves a list of all users from the ShipTown system.
This operation is useful when you want to fetch user data in bulk for reporting, synchronization, or further processing within an automation workflow. For example, you might use this node to pull all users to update a CRM system or to analyze user roles and permissions.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all user records or only up to the specified limit (true/false). |
| Limit | Maximum number of user records to return if "Return All" is false. Minimum value is 1. |
Output
The output is a JSON array where each element represents a user object as returned by the ShipTown API endpoint /api/admin/users. The structure of each user object depends on the ShipTown API response but typically includes user details such as ID, name, email, roles, and other metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the ShipTown API.
- The node expects the ShipTown API base URL to be configured in the credentials.
- Network access to the ShipTown API endpoints is necessary.
Troubleshooting
Common issues:
- Authentication failures due to invalid or missing API credentials.
- Network connectivity problems preventing access to the ShipTown API.
- API rate limits or restrictions causing partial or failed responses.
Error messages:
- Errors returned from the API will be included in the output if "Continue On Fail" is enabled.
- Typical error messages include authentication errors ("Unauthorized"), request timeouts, or invalid parameter errors.
Resolutions:
- Verify that the API key credential is correctly set up and has sufficient permissions.
- Check network connectivity and firewall settings.
- Adjust the "Limit" property or enable "Return All" carefully to avoid hitting API rate limits.
Links and References
- ShipTown API Documentation (for detailed information about user objects and API endpoints)
- n8n documentation on HTTP Request Node for understanding API calls and authentication setup