Magento

Integrate Magento actions with your AI bot

Magento is a powerful e-commerce platform that allows you to manage your online store, customer orders, and products. This integration connects your Magento store to the AI assistant, enabling automated order management, customer support, and inventory tracking.

Overview

The Magento integration provides AI-powered tools to:

• Retrieve order details and customer information

• Check payment status and process refunds

• Track order shipments and delivery status

• Send customer notifications

• Cancel orders when needed

Getting Started

Prerequisites

Before setting up the Magento integration, ensure you have:

• A Magento store with admin access

• API credentials (access token)

• Your Magento store URL

Setup Process

1. Log in to your Magento admin panel

2. Navigate to System > Extensions > Integrations

1. Click the Add New Integration button in the top-right corner.

1. Fill in the required details:

   • Name: Enter a descriptive name (e.g., "OurPortal_Orders_Integration").

   • Email: Provide a valid email address (this can be your own).

   • Callback URL and Identity Link URL: Leave these blank unless specified by our portal’s documentation.

   • Your Password: Enter your Magento admin password to authorize the integration.

2. Select the API button on the left.

1. The following permissions needed:

   • Sales (Orders, Invoices, Credit Memos)

   • Customer (Customer information)

   • Catalog (Product information)

2. After that, click the dropdown and press "Save and Activate."

3. Generate API credentials and note your access token can be seen on Integration Info

4. Enable OAuth Access Token usage (required):

   • Navigate to Stores > Configuration > Services > OAuth > Consumer Settings

   • Set Allow OAuth Access Tokens to be used as standalone Bearer tokens to Yes

   • Note: This setting must be active for the access token to work

Configuration

In your workspace integration settings, provide:

• Access Token: Your Magento API access token

• Magento URL: Your store's base URL (e.g., https://yourstore.com)

Available Actions

Order Management

Get Order Details

Retrieve comprehensive information about a specific order.

Use Cases:

• Customer support inquiries about order status

• Order verification and troubleshooting

• Order history lookup

Example:

Get order details for order #100001234

Get Orders by Customer Email

Find all orders associated with a customer's email address.

Use Cases:

• Customer service when customers can't remember order numbers

• Order history for repeat customers

• Support ticket resolution

Example:

Find all orders for [e-mail]

Payment Management

Check Payment Status

Verify the payment status of an order and get detailed payment information.

Use Cases:

• Resolving payment disputes

• Confirming payment completion

• Troubleshooting payment issues

Example:

Check payment status for order #100001234

Process Refunds

Create refunds for orders using Magento's credit memo system.

Use Cases:

• Customer returns and refunds

• Order cancellations with refunds

• Partial refunds for damaged items

Example:

Refund order #100001234 for $50.00 due to damaged product

Order Tracking

Get Order Tracking Information

Retrieve shipping and tracking details for orders.

Use Cases:

• Customer inquiries about delivery status

• "Where is my order?" support requests

• Delivery confirmation and tracking

Example:

Get tracking information for order #100001234

Customer Communication

Send Order Notices

Send automated notifications to customers about their orders.

Use Cases:

• Order status updates

• Shipping notifications

• Payment reminders

• Custom order communications

Example:

Send shipping update notice for order #100001234

Order Cancellation

Cancel Orders

Cancel orders that haven't been shipped yet.

Use Cases:

• Customer-requested cancellations

• Inventory issues

• Payment problems

Example:

Cancel order #100001234 due to customer request

Troubleshooting

Common Issues

Orders Not Appearing

• Solution: Refresh the page and check your API credentials

• Check: Ensure the integration has proper permissions for order access

API Authentication Errors

• Solution: Verify your access token is correct and hasn't expired

• Check: Confirm your Magento URL is accurate and accessible

Slow Synchronization

• Solution: Wait a few minutes for the sync to complete

• Check: Verify your server connection and API rate limits

Payment Status Issues

• Solution: Check if the order is in a terminal state (cancelled, completed, refunded)

• Check: Verify payment gateway integration is working properly

Related Integrations

• Picqer: Warehouse management and fulfillment

• Email Service: Customer notifications and communications

• Payment Gateways: Payment processing and refunds