Description

n8n-nodes-gambio

This is an n8n community node for the Gambio REST API v3. It allows you to integrate your Gambio GX4 e-commerce shop with n8n workflows.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

npm install n8n-nodes-gambio

Operations

This node supports both Gambio REST API v2 and v3 endpoints. The node automatically routes to the correct API version.

---

v2 API Resources

Additional Field

• Create: Create a new additional field
• Delete: Delete an additional field
• Get: Retrieve a specific additional field
• Get Many: Retrieve all additional fields
• Update: Update an additional field

Product Additional Field

• Create: Create additional field values for a product
• Delete: Delete additional field values from a product
• Get: Retrieve additional field values for a product
• Update: Update additional field values for a product

Address

• Create: Create a new address for a customer
• Delete: Delete an address
• Get: Retrieve a specific address
• Get Many: Retrieve all addresses
• Update: Update an existing address

Address Format

• Get Many: Retrieve all address formats

Attachment

• Upload: Upload an email attachment

Cache

• Clear All: Clear all shop caches
• Clear Email: Clear email templates cache
• Clear Filter: Clear filter cache
• Clear Module: Clear modules cache
• Clear Page: Clear page output cache
• Clear Products: Clear categories and products cache
• Clear Properties: Clear properties cache
• Clear Text: Clear text cache

Category

• Create: Create one or more categories
• Delete: Delete one or more categories
• Get: Retrieve a specific category
• Get Children: Retrieve child categories
• Get Many: Retrieve all categories
• Get Products: Retrieve products of a category
• Search: Search categories using advanced conditions
• Update: Update an existing category
• Update Many: Update multiple categories at once

Category Icon

• Delete: Delete a category icon file
• Get Many: Retrieve all category icon files
• Rename: Rename a category icon file
• Upload: Upload a category icon file

Category Image

• Delete: Delete a category image file
• Get Many: Retrieve all category image files
• Rename: Rename a category image file
• Upload: Upload a category image file

Country

• Get: Retrieve a specific country
• Get Many: Retrieve all countries
• Get Zones: Retrieve zones of a country

Cronjob

• Trigger Image Processing: Trigger the image processing cronjob to regenerate product images

Customer Group

• Create: Create a new customer group
• Delete: Delete a customer group
• Get: Retrieve a specific customer group
• Get Many: Retrieve all customer groups
• Update: Update an existing customer group

Customer (v2)

• Create: Create a new customer (registree or guest)
• Delete: Delete one or more customers
• Get: Retrieve a specific customer
• Get Many: Retrieve all customers (with type filter: guest/registree)
• Search: Search customers using advanced conditions
• Update: Update an existing customer
• Update Many: Update multiple customers at once

Email

• Delete: Delete an email from the queue
• Get: Retrieve a specific email
• Queue: Add an email to the queue
• Send: Send an email immediately

Language

• Get Many: Retrieve all shop languages

Manufacturer

• Create: Create a new manufacturer
• Delete: Delete a manufacturer
• Get: Retrieve a specific manufacturer
• Get Many: Retrieve all manufacturers
• Search: Search manufacturers
• Update: Update an existing manufacturer

Order (v2 API)

• Create: Create a new order
• Delete: Delete an order
• Get: Retrieve a specific order
• Get Many: Retrieve all orders
• Search: Search orders by various criteria
• Update: Update an existing order
• Update Status: Update the status of an order (with customer notification)

Order History

• Get: Retrieve order history by order ID
• Get Many: Retrieve all history entries for an order
• Get Single Entry: Retrieve a specific history entry

Order Item (v2 API)

• Create: Create a new order item
• Delete: Delete an order item
• Get: Retrieve a specific order item
• Get Many: Retrieve all items of an order
• Update: Update an order item

Order Item Attribute

• Create: Create order item attribute
• Delete: Delete order item attribute
• Get: Retrieve a specific order item attribute
• Get Many: Retrieve all order item attributes
• Update: Update order item attribute

Order Status (v2 API)

• Get History: Retrieve the status history of an order
• Get Totals: Retrieve the totals of an order
• Get Payment Details: Retrieve payment details
• Get Tracking Codes: Retrieve tracking codes of an order

Order Total

• Create: Create an order total
• Delete: Delete an order total
• Get: Retrieve a specific order total
• Get Many: Retrieve all order totals
• Update: Update an order total

Order Tracking Code

• Create: Create an order tracking code
• Get Many: Retrieve all tracking codes for an order

Parcel Service (v2)

• Create: Create a new parcel service
• Delete: Delete a parcel service
• Get: Retrieve a specific parcel service
• Get Many: Retrieve all parcel services
• Search: Search parcel services
• Update: Update an existing parcel service

Payment Details

• Get: Retrieve payment details for an order
• Get From Order: Retrieve payment details via order endpoint

Product (v2 API)

• Create: Create a new product
• Delete: Delete a product
• Get: Retrieve a specific product
• Get Many: Retrieve all products
• Search: Search products by various criteria
• Update: Update an existing product
• Update Stock: Update the stock quantity

Product Image

• Delete: Delete a product image file
• Get Many: Retrieve all product image files
• Rename: Rename a product image file
• Upload: Upload a product image file

Product Link

• Create: Link a product to a category
• Delete: Remove product-category link
• Get Many: Retrieve all category links for a product
• Update: Change product-category link

Product Price

• Delete: Delete product prices
• Get: Retrieve product prices
• Get Graduated Price: Retrieve graduated product price
• Update: Update product prices

Quantity Unit

• Create: Create a new quantity unit
• Delete: Delete a quantity unit
• Get: Retrieve a specific quantity unit
• Get Many: Retrieve all quantity units
• Update: Update an existing quantity unit

Review

• Create: Create a new review
• Delete: Delete a review
• Get: Retrieve a specific review
• Get Many: Retrieve all reviews
• Update: Update an existing review

Shop Information

• Get: Retrieve shop information

Special Offer

• Create: Create a new special offer
• Delete: Delete a special offer
• Get: Retrieve a specific special offer
• Get Many: Retrieve all special offers
• Search: Search special offers
• Update: Update an existing special offer

Tax

• Get Classes: Retrieve all tax classes
• Get Rates: Retrieve all tax rates
• Get Zones: Retrieve all tax zones

Tracking Code (v2)

• Delete: Delete a tracking code
• Get: Retrieve a specific tracking code
• Get Many: Retrieve all tracking codes

VPE (Packaging Unit)

• Create: Create a new VPE
• Delete: Delete a VPE
• Get: Retrieve a specific VPE
• Get Many: Retrieve all VPEs
• Update: Update an existing VPE

Withdrawal (v2)

• Create: Create a new withdrawal
• Delete: Delete a withdrawal
• Get: Retrieve a specific withdrawal
• Get Many: Retrieve all withdrawals
• Update: Update an existing withdrawal

Zone

• Get: Retrieve a specific zone

---

v3 API Resources

Currency (v3 API)

• Get: Retrieve a specific currency
• Get Many: Retrieve all currencies

Customer (v3 API)

• Create: Register a new customer
• Delete: Delete one or more customers
• Delete Guest Accounts: Delete outdated guest accounts
• Get: Retrieve a specific customer
• Get Many: Retrieve all customers
• Update: Update an existing customer
• Update Favorite Status: Update the is-favorite state

Customer Addon Value (v3 API)

• Create: Create a new customer addon value
• Delete: Delete customer addon values
• Delete All: Delete all addon values of a customer
• Get: Retrieve a specific addon value
• Get Many: Retrieve all addon values
• Update: Update a customer addon value

Customer Memo (v3 API)

• Create: Create a new customer memo
• Delete: Delete customer memos
• Delete All: Delete all memos of a customer
• Get: Retrieve a specific memo
• Get Many: Retrieve all memos
• Update: Update a customer memo

Image List (v3 API)

• Create: Create a new image list
• Delete: Delete image lists
• Get: Retrieve a specific image list
• Get Many: Retrieve all image lists
• Update: Update an image list

Option (v3 API)

• Create: Create a new option
• Delete: Delete options
• Get: Retrieve a specific option
• Get Many: Retrieve all options
• Update: Update an option
• Update Sort Order: Update the sort order

Parcel Service (v3 API)

• Create: Create a new parcel service
• Delete: Delete parcel services
• Get: Retrieve a specific parcel service
• Get Many: Retrieve all parcel services
• Update: Update a parcel service

Product Option (v3 API)

• Create: Create a new product option
• Delete: Delete product options
• Delete All: Delete all product options
• Get: Retrieve a specific product option
• Get Many: Retrieve all product options
• Update: Update a product option

Product Variant (v3 API)

• Add Options: Add options to existing variants
• Create: Create a new product variant
• Delete: Delete product variants
• Delete All: Delete all product variants
• Generate: Generate variants from option combinations
• Get: Retrieve a specific variant
• Get Many: Retrieve all variants
• Remove Options: Remove options from variants
• Update: Update a product variant

Tracking Code (v3 API)

• Create: Create a new tracking code
• Delete: Delete tracking codes
• Get: Retrieve a specific tracking code
• Get Many: Retrieve all tracking codes

Withdrawal (v3 API)

• Create: Create a new withdrawal
• Delete: Delete withdrawals
• Get: Retrieve a specific withdrawal
• Get Many: Retrieve all withdrawals

Credentials

This node supports two authentication methods:

Basic Auth

Use your Gambio admin username and password.

Bearer Token (JWT)

Generate a JWT token from Customers → Roles and Permissions in the Gambio Admin panel.

Compatibility

• Gambio GX4 v4.1.1.0 or later
• n8n v0.187.0 or later

API Documentation

For detailed information about the Gambio REST API, refer to the official Gambio API documentation.

Query Parameters

When using "Get Many" operations, you can utilize the following additional fields:

Filtering

Use the filter parameter with field names and values:

• Wildcards: J* (starts with J), *1 (ends with 1)
• Operators: gt|42, gte|42, lt|42, lte|42, neq|42, eq|value

Sorting

Comma-separated list with + (ascending) or - (descending):

• Example: -creationDate,+customer.firstName

Pagination

• page: Page number (default: 1)
• perPage: Items per page (1-100, default: 25)

Field Selection

Comma-separated list of fields to return:

• Example: id,customer.firstName,customer.lastName

Example Usage

Get All Orders (with filters)

1. Add a Gambio node to your workflow
2. Select "Order" as resource
3. Select "Get Many" as operation
4. Use Additional Fields to filter:
   • Changed Since: Only orders modified after a specific date
   • Search: Filter by customer name, order ID, etc.
   • Per Page: Limit results (default: 50)

Find Orders by Customer Email

1. Add a Gambio node to your workflow
2. Select "Order" as resource
3. Select "Search" as operation
4. Enter customer email or name in "Search Query"

Update Order Status

1. Add a Gambio node to your workflow
2. Select "Order" as resource
3. Select "Update Status" as operation
4. Enter Order ID, Status ID
5. Choose whether to notify the customer
6. Optionally add a comment

Get All Customers

1. Add a Gambio node to your workflow
2. Select "Customer" as resource
3. Select "Get Many" as operation
4. Configure pagination and filters as needed

Create a Tracking Code

1. Add a Gambio node to your workflow
2. Select "Tracking Code" as resource
3. Select "Create" as operation
4. Provide JSON body with tracking code data:

[{
  "orderId": 1,
  "code": "123456789",
  "isReturnDelivery": false,
  "parcelService": {
    "id": 1,
    "languageCode": "de",
    "name": "DHL",
    "url": "https://www.dhl.de/de/privatkunden/pakete-empfangen/verfolgen.html?piececode=123456789"
  },
  "createdOn": "2024-01-15 10:30:00"
}]

License

MIT

Author

Koralp

Resources

• n8n Community Nodes Documentation
• Gambio API Documentation