Actions20
Overview
This node integrates with the ShipTown API to manage various resources including users, orders, products, inventory, and more. Specifically, for the User resource with the Get Roles operation, it retrieves the list of user roles defined in the ShipTown system.
This operation is useful when you need to:
- Fetch all available user roles for assigning or managing permissions.
- Synchronize user role data from ShipTown into another system.
- Display role options dynamically in workflows that involve user management.
Example use case: An automation workflow that assigns roles to new users based on predefined criteria can first fetch all roles using this operation to validate or select appropriate roles.
Properties
| Name | Meaning |
|---|---|
| Limit | Max number of results to return. (Applicable if "Return All" is false) |
| Return All | Whether to return all results or only up to the limit specified by "Limit". |
For this specific operation ("Get Roles"), the Limit and Return All properties are available but typically the API returns all roles without pagination, so these may have limited effect.
Output
The output is a JSON array where each item represents a user role object as returned by the ShipTown API endpoint /api/admin/user/roles.
Typical structure of each role object includes fields such as:
- Role ID
- Role name
- Description or permissions associated with the role (depending on API response)
No binary data is returned by this operation.
Dependencies
- Requires an API key credential for authenticating with the ShipTown API.
- The node uses the base URL configured in the credentials to send requests.
- The API expects JSON responses and sends JSON payloads.
Troubleshooting
Common issues:
- Authentication errors if the API key or domain is incorrect or missing.
- Network connectivity problems preventing access to the ShipTown API.
- Unexpected empty results if no roles are defined in the ShipTown account.
Error messages:
- Errors from the API will be surfaced with their message; ensure the API key has sufficient permissions.
- If the node fails, enabling "Continue On Fail" allows the workflow to proceed while capturing error details in the output.
Links and References
- ShipTown API Documentation (for detailed info on user roles endpoint)
- n8n documentation on HTTP Request Node for understanding API calls in custom nodes