n8n-nodes-shiptown

This is an n8n community node that allows you to interact with the ShipTown API.

ShipTown is an inventory management system that provides APIs for managing orders, products, inventory, warehouses, and more.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

1. Go to Settings > Community Nodes.
2. Select Install.
3. Enter n8n-nodes-shiptown in Enter npm package name.
4. Agree to the risks of using community nodes: select I understand the risks of installing unverified code from a public source.
5. Select Install.

After installing the node, you can use it like any other node in your workflows.

Credentials

To use this node, you need to set up ShipTown API credentials:

1. In your ShipTown instance, go to Menu > Settings > API > Create API Token
2. Copy the generated API token
3. In n8n, create new ShipTown API credentials:
   • Domain: Your ShipTown instance URL (e.g., https://demo.myshiptown.com)
   • API Token: The token you generated in step 2

Supported Resources

This node supports the following ShipTown resources:

Activity

• Get All: Retrieve all activities
• Create: Create a new activity

Order

• Get All: Retrieve all orders
• Get: Get a specific order by ID
• Create: Create a new order
• Update: Update an existing order
• Delete: Delete an order

Product

• Get All: Retrieve all products
• Get: Get a specific product by ID
• Create: Create a new product
• Update: Update an existing product
• Delete: Delete a product

Inventory

• Get All: Retrieve all inventory records
• Get Movements: Get inventory movements

Data Collector

• Get All: Retrieve all data collector records
• Get Comments: Get data collector comments

Warehouse

• Get All: Retrieve all warehouses
• Get: Get a specific warehouse by ID

User

• Get All: Retrieve all users
• Get Roles: Get user roles

Usage

1. Add the ShipTown node to your workflow
2. Select the resource you want to work with
3. Choose the operation to perform
4. Configure the required parameters
5. Connect your ShipTown API credentials
6. Execute the workflow

Example Workflows

Get All Products

1. Add a ShipTown node
2. Select Product as the resource
3. Select Get All as the operation
4. Set Return All to true or specify a limit
5. Execute to get all products from your ShipTown instance

Create an Activity

1. Add a ShipTown node
2. Select Activity as the resource
3. Select Create as the operation
4. Fill in the required fields:
   • Log Name
   • Description
   • Subject Type
   • Subject ID
5. Execute to create the activity

Compatibility

This node has been tested with:

• n8n version 1.0 and above
• ShipTown API version 1.0

Resources

• n8n community nodes documentation
• ShipTown API documentation

License

MIT