n8n-nodes-ecommerce-api

Generic e-commerce API integration node for n8n workflow automation.

Description

This package provides a powerful n8n node for e-commerce API integration with two main operations:

E-commerce API Node

Operation 1: Get Product List

• Retrieve product lists from e-commerce APIs
• Filter products by SKU
• Include/exclude stock information
• Support for pagination and bulk operations

Operation 2: Submit Order

• Submit orders directly to e-commerce APIs
• Complete customer information handling
• Product line items with quantities
• Shipping and payment method support
• Order tracking and metadata

Installation

Community Nodes (Recommended)

1. Go to Settings > Community Nodes in your n8n instance
2. Click Install a community node
3. Enter: n8n-nodes-ecommerce-api
4. Click Install

Manual Installation

# In your n8n root directory
npm install n8n-nodes-ecommerce-api

Development Installation

# Clone this repository
git clone https://github.com/your-username/n8n-nodes-ecommerce-api.git
cd n8n-nodes-ecommerce-api

# Install dependencies
npm install

# Build the nodes
npm run build

# Link to your n8n installation
npm link
cd /path/to/your/n8n
npm link n8n-nodes-ecommerce-api

Node Operations

This package provides one main node with two operations:

E-commerce API Node

Operation: Get Product List

Retrieves product information from the e-commerce API.

Features:

• Get all available products
• Filter products by SKU pattern
• Include/exclude stock information
• Returns product details (SKU, name, description, price, stock)

Operation: Submit Order

Submits orders to the e-commerce API.

Features:

• Submit orders with customer information
• Support multiple products per order
• Optional shipping and payment details
• Real-time order processing

Configuration

Credentials Setup

1. Create new credentials of type E-commerce API Credentials
2. Enter your API credentials:
   • API Secret Key: Your API authentication key
   • API Base URL: The base URL for the API (default: https://woo.bizapp.my)

Usage Examples

Get Product List

{
  "operation": "getAll",
  "additionalOptions": {
    "filterSku": "PROD",
    "includeStock": true
  }
}

Submit Order

{
  "operation": "submit",
  "customerName": "John Doe",
  "customerAddress": "123 Main St, City, State 12345",
  "customerPhone": "+1234567890",
  "customerEmail": "[email protected]",
  "totalPrice": 99.99,
  "products": {
    "productItems": [
      {
        "sku": "PROD001",
        "quantity": 2
      },
      {
        "sku": "PROD002",
        "quantity": 1
      }
    ]
  },
  "additionalOptions": {
    "shippingPrice": 10.00,
    "orderNotes": "Please handle with care",
    "paymentMethod": "Credit Card"
  }
}

API Compatibility

This package is designed to work with e-commerce APIs that support:

• RESTful endpoints
• JSON/Form data communication
• Standard authentication methods

Error Handling

Both nodes include comprehensive error handling:

• Network timeouts (30 seconds)
• Invalid response formats
• Authentication failures
• Missing required parameters

Development

# Install dependencies
npm install

# Build for development
npm run dev

# Build for production
npm run build

# Run linting
npm run lint

# Format code
npm run format

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

License

MIT License - see LICENSE file for details.

Support

For issues and questions:

• Create an issue on GitHub
• Check the n8n community forum
• Review the documentation

Changelog

1.0.0

• Initial release
• E-commerce API node with Get Product List operation
• E-commerce API node with Submit Order operation
• Generic API credentials support