Actions20
Overview
This node integrates with the ShipTown API to manage various resources such as activities, orders, products, inventory, warehouses, users, and data collectors. Specifically, for the Activity - Create operation, it allows users to create a new activity log entry in ShipTown. This is useful for tracking events or actions related to specific subjects (e.g., orders) within the ShipTown system.
Practical examples include:
- Logging an update or status change on an order.
- Recording custom notes or descriptions about a particular subject.
- Adding metadata or additional properties to enrich activity records for auditing or reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Log Name | The name/title of the activity log entry (max 255 characters). |
| Description | A detailed description of the activity being logged. |
| Subject Type | The type of the subject the activity relates to. Options: Order. |
| Subject ID | The numeric ID of the subject (e.g., order ID) this activity is associated with. |
| Additional Fields | Optional collection for extra data; currently supports: |
| - Properties | JSON object containing additional custom properties to attach to the activity record. |
Output
The node outputs the JSON response returned by the ShipTown API after creating the activity. This typically includes details of the newly created activity such as its ID, timestamps, log name, description, subject information, and any additional properties provided.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the ShipTown API via an API key credential.
- The node expects the base URL for the ShipTown API to be configured in the credentials.
- Proper authentication setup in n8n is necessary to authorize API requests.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing malformed JSON in the "Properties" field may result in parsing errors.
- Using an invalid or non-existent subject ID could lead to API errors.
- Exceeding character limits for "Log Name" might cause request rejection.
Error messages:
- Authentication errors usually indicate incorrect or expired API keys; verify and update credentials.
- JSON parse errors suggest invalid JSON syntax in additional properties; ensure valid JSON format.
- API validation errors often point to missing required fields or invalid values; double-check input parameters.
Links and References
- ShipTown API Documentation (for detailed API endpoints and data models)
- n8n HTTP Request Node Documentation (for understanding API request handling in n8n)