Magento

1. Overview

Magento is a powerful, open-source eCommerce platform that enables businesses to create and manage online stores with extensive customization capabilities. Through Magento's comprehensive REST API, businesses can programmatically manage their entire eCommerce ecosystem, from customer relationships to inventory management.

Through GoInsight's Magento node, you can seamlessly integrate eCommerce operations into your automated workflows. You can perform complete lifecycle management of your online store's key resources, including:

• Customer Management: Create, retrieve, update, delete, and search for customers with full profile information.
• Product Catalog Management: Manage your product inventory with complete CRUD operations including SKU management, pricing, and attributes.
• Order Processing: Retrieve, list, and cancel orders with comprehensive order details and status tracking.
• Invoice Generation: Create invoices for orders and capture payments automatically.
• Shipment Management: Create shipments for orders with tracking information and carrier details.

2. Prerequisites

Before using this node, you need to meet the following conditions:

• Account Requirements: You need to have a valid Magento instance with administrator access to create and manage API credentials.
• Permission Requirements: You need admin or integration permissions to create and manage API access tokens. The integration should have the necessary permissions for the resources you want to access (customers, products, orders, etc.).

3. Credentials

For detailed guidance on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This node primarily operates around five core resources: Customers, Products, Orders, Invoices, and Shipments. It provides comprehensive management capabilities for eCommerce operations.

Total: 15 API Operations - Complete coverage of all Magento REST API endpoints including customer management, product catalog management, order processing, invoice generation, and shipment management.

Operation Details

Create a Customer

Create a new customer account in Magento with complete profile information including email, name, password, and store associations.

Input Parameters:

• Email: Customer's email address (required, must be unique).
• Firstname: Customer's first name (required).
• Lastname: Customer's last name (required).

Options:

• Password: Customer account password (optional, system will auto-generate if empty).
• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• WebsiteId: Website ID for customer association (optional, defaults to 1).
• StoreId: Store view ID for customer association (optional, defaults to 1).
• GroupId: Customer group ID for group assignment (optional, defaults to 1).

Output:

• CustomerId (number): The ID of the newly created customer, 0 if creation failed.
• CustomerData (object): Complete customer information including: id, email, firstname, lastname, store_id, website_id, group_id, created_at, updated_at, and addresses.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Get a Customer

Retrieve detailed information for a specific customer by ID or get the current customer's information using the /me endpoint.

Input Parameters:

• CustomerId: The ID of the customer to retrieve (required when UseMeEndpoint is false, defaults to 0). You can obtain this ID from the "Create a New Customer" action output or the "Get All Customers" action results.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• UseMeEndpoint: Whether to use the /me endpoint to get current customer information (optional, defaults to false).

Output:

• CustomerId (number): The ID of the retrieved customer.
• CustomerData (object): Complete customer information including: id, email, firstname, lastname, store_id, website_id, group_id, created_at, updated_at, addresses, and custom attributes.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Get All Customers

Retrieve a paginated list of customers with advanced filtering and search capabilities using searchCriteria parameters.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• PageSize: Number of customers to return per page (optional, defaults to 20).
• CurrentPage: Current page number for pagination (optional, defaults to 1).
• SearchCriteria: Search criteria object for advanced filtering (optional). Use Magento bracket keys after searchCriteria, for example {"[filter_groups][0][filters][0][field]": "email", "[filter_groups][0][filters][0][value]": "%@gmail.com%", "[filter_groups][0][filters][0][condition_type]": "like"}. Common fields: email, firstname, lastname, created_at, group_id. Condition types: eq (exact match), like (contains), gt/lt (greater/less than), in (in array), neq (not equal). Leave {} when no filtering is needed.

Output:

• Items (array): List of customer objects. Each customer object contains: id, email, firstname, lastname, group_id, store_id, website_id, created_at, updated_at, and addresses.
• TotalCount (number): Total number of customers matching the search criteria.
• PageSize (number): Number of items per page.
• CurrentPage (number): Current page number.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Update a Customer

Update existing customer information including email, name, and group assignments while preserving customer history.

Input Parameters:

• CustomerId: The ID of the customer to update (required). You can obtain this ID from the "Create a New Customer" action output or the "Get All Customers" action results.

Options:

• Email: New email address for the customer (optional).
• Firstname: New first name for the customer (optional).
• Lastname: New last name for the customer (optional).
• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• GroupId: New customer group ID (optional, 0 means no change).

Output:

• CustomerId (number): The ID of the updated customer.
• CustomerData (object): Updated customer information including: id, email, firstname, lastname, store_id, website_id, group_id, created_at, updated_at, and addresses.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Delete a Customer

Permanently delete a customer account from the Magento system.

Input Parameters:

• CustomerId: The ID of the customer to delete (required). You can obtain this ID from the "Create a New Customer" action output or the "Get All Customers" action results.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").

Output:

• Success (bool): Whether the deletion was successful.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Create a Product

Create a new product in the Magento catalog with complete product information including SKU, name, price, attributes, and inventory settings.

Input Parameters:

• Sku: Product SKU identifier (required, must be unique).
• Name: Product name (required).
• Price: Product price (required).
• AttributeSetId: Attribute set ID for the product (required). The attribute set ID determines which attributes are available for this product. Common values: 4 (Default attribute set). To find your attribute set IDs: 1) Log in to Magento Admin panel. 2) Navigate to Stores > Attributes > Attribute Set. 3) View the attribute set list and note the IDs. Different attribute sets support different product types (simple, configurable, etc.).

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• ProductType: Product type (optional, defaults to "simple"). Common values: simple, configurable, grouped, bundle, virtual, downloadable.
• Weight: Product weight (optional, defaults to 0.0).
• Status: Product status (optional, defaults to 1). 1 = Enabled, 2 = Disabled.
• Visibility: Product visibility (optional, defaults to 4). 1 = Not Visible Individually, 2 = Catalog, 3 = Search, 4 = Catalog and Search.

Output:

• ProductId (number): The ID of the newly created product, 0 if creation failed.
• ProductData (object): Complete product information including: id, sku, name, price, attribute_set_id, type_id, weight, status, visibility, created_at, updated_at, and custom attributes.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request), 401 (unauthorized), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Get a Product

Retrieve detailed information for a specific product by SKU including all attributes, pricing, and inventory status.

Input Parameters:

• Sku: Product SKU to retrieve (required). You can obtain this from the "Create a Product" action output or the "Get All Products" action results.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").

Output:

• ProductId (number): The ID of the retrieved product.
• ProductData (object): Complete product information including: id, sku, name, price, attribute_set_id, type_id, weight, status, visibility, created_at, updated_at, extension_attributes, and custom attributes.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Get All Products

Retrieve a paginated list of products with advanced filtering and search capabilities using searchCriteria parameters.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• PageSize: Number of products to return per page (optional, defaults to 20).
• CurrentPage: Current page number for pagination (optional, defaults to 1).
• SearchCriteria: Search criteria object for advanced filtering (optional). Use Magento bracket keys after searchCriteria, for example {"[filter_groups][0][filters][0][field]": "sku", "[filter_groups][0][filters][0][value]": "PROD-%", "[filter_groups][0][filters][0][condition_type]": "like"}. Common fields: sku, name, price, status, type_id, created_at. Condition types: eq (exact match), like (contains), gt/lt (greater/less than), in (in array), neq (not equal). Leave {} when no filtering is needed.

Output:

• Items (array): List of product objects. Each product object contains: id, sku, name, price, attribute_set_id, type_id, weight, status, visibility, created_at, updated_at, and custom attributes.
• TotalCount (number): Total number of products matching the search criteria.
• PageSize (number): Number of items per page.
• CurrentPage (number): Current page number.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Update a Product

Update existing product information including name, price, status, weight, and custom attributes.

Input Parameters:

• Sku: Product SKU to update (required). You can obtain this from the "Create a Product" action output or the "Get All Products" action results.

Options:

• Name: New product name (optional).
• Price: New product price (optional).
• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• Status: New product status (optional). 1 = Enabled, 2 = Disabled.
• Weight: New product weight (optional).

Output:

• ProductId (number): The ID of the updated product.
• ProductData (object): Updated product information including: id, sku, name, price, attribute_set_id, type_id, weight, status, visibility, created_at, updated_at, and custom attributes.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Delete a Product

Permanently delete a product from the Magento catalog by SKU.

Input Parameters:

• Sku: Product SKU to delete (required). You can obtain this from the "Create a Product" action output or the "Get All Products" action results.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").

Output:

• Success (bool): Whether the deletion was successful.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Get an Order

Retrieve detailed information for a specific order including customer details, line items, shipping information, and payment status.

Input Parameters:

• OrderId: Positive numeric Magento order entity_id to retrieve (required). Use the entity_id field from "Get All Orders" action results; do not pass the human-readable order number.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").

Output:

• OrderId (number): Magento order entity_id returned by the API.
• OrderData (object): Complete order information including: entity_id, increment_id, status, state, customer_email, customer_firstname, customer_lastname, grand_total, subtotal, items (line items), billing_address, shipping_address, payment, created_at, and updated_at.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Get All Orders

Retrieve a paginated list of orders with advanced filtering and search capabilities using searchCriteria parameters.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• PageSize: Number of orders to return per page (optional, defaults to 20).
• CurrentPage: Current page number for pagination (optional, defaults to 1).
• SearchCriteria: Search criteria object for advanced filtering (optional). Use Magento bracket keys after searchCriteria, for example {"[filter_groups][0][filters][0][field]": "status", "[filter_groups][0][filters][0][value]": "pending", "[filter_groups][0][filters][0][condition_type]": "eq"}. Common fields: entity_id, status, customer_email, grand_total, created_at. Condition types: eq (exact match), like (contains), gt/lt (greater/less than), in (in array), neq (not equal). Leave {} when no filtering is needed.

Output:

• Items (array): List of order objects. Each order object contains: entity_id, increment_id, status, state, customer_email, customer_firstname, customer_lastname, grand_total, subtotal, items, billing_address, shipping_address, payment, created_at, and updated_at.
• TotalCount (number): Total number of orders matching the search criteria.
• PageSize (number): Number of items per page.
• CurrentPage (number): Current page number.
• StatusCode (number): Operation result code: 200 (success), 401 (unauthorized), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Cancel an Order

Cancel an existing order and update its status to canceled in the Magento system.

Input Parameters:

• OrderId: The ID of the order to cancel (required). You can obtain this from the "Get All Orders" action results or from your Magento admin panel.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").

Output:

• Success (bool): Whether the cancellation was successful.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request - order may already be canceled or completed), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Create an Invoice

Create an invoice for an existing order with optional payment capture functionality.

Input Parameters:

• OrderId: The ID of the order to invoice (required). You can obtain this from the "Get All Orders" action results or from your Magento admin panel.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• Capture: Whether to capture payment online (optional, defaults to true). Set to true to capture payment immediately, false to invoice without capturing.

Output:

• InvoiceId (number): The ID of the created invoice, 0 if creation failed.
• InvoiceData (object): Complete invoice information including: entity_id, increment_id, order_id, state, grand_total, subtotal, items, created_at, and updated_at.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request - order may already have invoice), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

Ship an Order

Create a shipment for an order with tracking information, carrier code, and notification options.

Input Parameters:

• OrderId: The ID of the order to ship (required). You can obtain this from the "Get All Orders" action results or from your Magento admin panel.

Options:

• StoreCode: Store code for multi-store setup (optional, defaults to "default").
• Notify: Whether to send shipment notification email to customer (optional, defaults to false).
• TrackingNumber: Shipment tracking number (optional, empty string if not available).
• CarrierCode: Shipping carrier code (optional, defaults to "custom"). Common values: custom (Custom carrier), ups (UPS), usps (USPS), fedex (FedEx), dhl (DHL), tablerate (Table Rate), flatrate (Flat Rate), freeshipping (Free Shipping).

Output:

• ShipmentId (number): The ID of the created shipment, 0 if creation failed.
• ShipmentData (object): Complete shipment information including: entity_id, increment_id, order_id, customer_id, tracks (tracking information), items, created_at, and updated_at.
• StatusCode (number): Operation result code: 200 (success), 400 (bad request - order may already be shipped), 401 (unauthorized), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string): Error description if operation fails, empty string on success.

5. Example Usage

This section will guide you through creating a simple workflow to create a new customer in your Magento store. This is one of the most fundamental operations for managing your customer base.

Workflow Overview: The example workflow consists of three nodes: Start -> Magento (Create a New Customer) -> Answer.

Step-by-Step Guide:

1. Add the Magento Node:
   • In the workflow canvas, click the "+" button to add a new node.
   • In the panel that appears, select the "Tools" tab.
   • Find and select Magento from the tools list.
   • In the list of supported operations for Magento, click and select Create a New Customer. This will add the corresponding node to your canvas.
2. Configure the Node:
   • Click on the newly added Create a New Customer node. The configuration panel will expand on the right side.
   • Credentials Configuration: At the top of the panel, locate the credentials field. Click the dropdown menu and select your pre-configured Magento credentials. If you haven't set up credentials yet, refer to section 3 of this guide.
   • Parameter Configuration: Fill in the required input parameters:
   • Email: Enter a unique email address for the new customer, for example: john.doe@example.com. This email must not already exist in your Magento system.
   • Firstname: Enter the customer's first name, for example: John.
   • Lastname: Enter the customer's last name, for example: Doe.
   • Optional Parameters: You can also configure optional parameters if needed:
   • Password: Enter a password for the customer account. If left empty, Magento will auto-generate one.
   • StoreCode: Keep the default value "default" for single-store setups, or enter your specific store code for multi-store configurations.
   • WebsiteId, StoreId, GroupId: Keep the default values (1, 1, 1) unless you have specific requirements for your store setup.
3. Run and Verify:
   • Once all required parameters are correctly filled in, any error indicators in the workflow canvas will disappear.
   • Click the "Test Run" button in the upper right corner of the canvas to execute the workflow.
   • After successful execution, click the log icon in the upper right corner to view the node's detailed input and output.
   • In the output, you should see:
   • CustomerId: The ID of the newly created customer (e.g., 123)
   • CustomerData: The complete customer information object
   • StatusCode: 200 (indicating success)
   • ErrorMessage: Empty string (no errors)
   • You can verify the customer was created by logging into your Magento admin panel and navigating to Customers > All Customers.

Workflow Complete: After completing these steps, your workflow is fully configured. When you click "Test Run", a new customer will be successfully created in your Magento store. You can now use the CustomerId from the output in subsequent workflow nodes for operations like updating the customer, retrieving their information, or associating them with orders.

6. FAQs

Q: I'm getting a 401 Unauthorized error when trying to use the Magento node. What should I check?

A: Please verify the following:

• Ensure your Access Token is correctly configured in the credentials.
• Check that your Access Token hasn't expired. Magento Admin tokens don't typically expire, but Integration tokens may have expiration settings.
• Verify that your Magento API user or integration has the necessary permissions for the operation you're trying to perform.
• Confirm that the Base URL is correct and includes the protocol (https://).

Q: How do I find my Attribute Set ID when creating a product?

A: To find your Attribute Set IDs:

• Log in to your Magento Admin panel.
• Navigate to Stores > Attributes > Attribute Set.
• You'll see a list of attribute sets with their IDs. The default attribute set typically has ID 4.
• Different attribute sets support different product types (simple, configurable, bundle, etc.).

Q: Can I use search criteria to filter results in "Get All" operations?

A: Yes. All "Get All" operations (customers, products, orders) support advanced filtering using the SearchCriteria parameter. SearchCriteria is an object that uses Magento bracket keys for field, value, and condition_type parameters. Common condition types include:

• eq for exact matches
• like for partial matches (use % as wildcard)
• gt/lt for greater than/less than comparisons
• in for matching multiple values

Example: {"[field][0][field]": "email", "[field][0][value]": "%@gmail.com%", "[field][0][condition_type]": "like"}

Q: Why does my product creation fail with a 400 error?

A: Common reasons for product creation failures include:

• The SKU already exists in your catalog (SKU must be unique).
• The Attribute Set ID is invalid or doesn't exist.
• Required custom attributes for the attribute set are missing.
• The price format is invalid (should be a number).
• You're trying to create a product type that requires additional parameters (e.g., configurable products need variant information).

Q: Can I test these operations without affecting my production store?

A: Yes, it's highly recommended to test on a development or staging Magento instance first. Most Magento hosting providers offer staging environments. You can also:

• Set up a local Magento development environment using tools like Docker or XAMPP.
• Use a separate Magento store specifically for testing.
• Enable the "Developer Mode" in Magento for more detailed error messages during testing.

Q: How do I handle SSL certificate verification errors in test environments?

A: If you're testing with a self-signed SSL certificate or a local environment, you may encounter SSL verification errors. The Magento nodes support a verify_ssl parameter (set to False in test environments). However, for security reasons, SSL verification should always be enabled in production environments.

7. Official Documentation

For advanced use cases and detailed API reference, please consult the official Magento API documentation:

Magento REST API Documentation