Overview
The Akeneo custom n8n node allows you to interact with the Akeneo PIM (Product Information Management) system. Specifically, for the Product resource and the Patch operation, this node updates an existing product's details in Akeneo. This is useful when you need to programmatically modify product information such as SKU, family, parent, categories, groups, price, enabled status, or associated files.
Common scenarios:
- Updating product data after changes in your ERP or e-commerce platform.
- Automating catalog management workflows where product attributes need regular adjustments.
- Bulk updating product prices, categories, or group assignments.
Example:
You have a product whose price and category need to be updated based on new supplier data. Using this node, you can patch the product by its SKU and set the new values automatically.
Properties
Name | Type | Meaning |
---|---|---|
SKU | String | The unique identifier (SKU) of the product to update. Required. |
Novo indentidicador(SKU) | String | New SKU to assign to the product (if changing the identifier). Optional for patch. |
Family | String | The family code to which the product belongs. |
Parent | String | The parent product identifier (for variant products). |
Enabled | Boolean | Whether the product is enabled (active) or not. |
Categories | Fixed Collection | List of categories to assign to the product. Each entry has a "categotyValue" string. |
Groups | Fixed Collection | List of groups to assign to the product. Each entry has a "groupsValue" string. |
Price | Fixed Collection | List of price objects. Each entry has "priceValue" (number) and "coinValue" (currency code). |
Nome | String | Product name query (not directly used in patch, but present in properties). |
File Path | String | Path to a file to associate with the product (e.g., image). |
Output
- The node outputs a
json
object with at least the following field:response
: Contains the response from the Akeneo API after attempting to patch the product. This will typically include the updated product data or error information.- If an error occurs, an additional field
message
may be present with error details from Akeneo.
Example output:
{
"response": {
// Akeneo API response for the PATCH operation
},
"message": "Error details if any"
}
Dependencies
- External Service: Requires access to an Akeneo PIM instance with API credentials.
- API Credentials: You must configure the
akeneoApi
credential in n8n, including:- Client ID
- Secret
- Username
- Password
- Domain (base URL of your Akeneo instance)
- n8n Configuration: No special environment variables are required beyond the credential setup.
Troubleshooting
Common Issues:
- Invalid Credentials: If the provided API credentials are incorrect, authentication will fail. Ensure all fields in the
akeneoApi
credential are correct. - Missing Required Fields: The SKU (
identifier
) is required. Omitting it will result in an error. - Invalid Category/Group/Family Codes: Providing codes that do not exist in Akeneo will cause the API to return errors.
- File Not Found: If a file path is specified but the file does not exist or is inaccessible, the node will throw a file read error.
- API Errors: Any error returned by Akeneo (such as validation errors) will appear in the
message
field of the output.
Error Messages:
"message": "Error details from Akeneo"
— Review the message for specifics (e.g., missing fields, invalid codes).- File system errors (e.g., ENOENT) indicate issues with the provided file path.
How to resolve:
- Double-check all input property values, especially identifiers and file paths.
- Verify API credentials and permissions.
- Consult the Akeneo API documentation for valid codes and expected formats.