For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set up Magento

Connecting Magento screen by screen: create the integration in Magento Admin, copy the four values it gives you, and paste them with your store URL into the secure form in eesel.

Connecting Magento, screen by screen. You create an integration in your Magento Admin, and Magento hands you four values. You paste those four values, plus your store URL, into a secure form in the eesel chat. You do it once. For what your teammate does with the store, see the Magento overview.

Before you begin

  • You need admin access to your Magento store, so you can reach System > Extensions > Integrations.

  • Your store should be Magento 2. The screens here are Magento 2's. Every 2.x version connects the same way.

  • Have your store's base URL ready, for example https://store.example.com.

Walkthrough

1

Create a new integration in Magento Admin

Sign in to your Magento Admin as an admin. In the left sidebar open System, then under Extensions choose Integrations, and click Add New Integration.

The Magento Admin Integrations list with a callout on the Add New Integration button
The Integrations list in Magento Admin.

Give it a name you will recognise later. Leave Callback URL and Identity link URL blank, because eesel uses neither. Magento may ask for your admin password further down the form, under Current User Identity Verification.

The Magento New Integration form with callouts to give it a name and to leave Callback URL and Identity link URL blank
The New Integration form, with the name filled in.
2

Grant the API resource access

Open the API tab, set Resource Access to All, then click Save. That gives the integration everything your admin account can reach, and returns you to the Integrations list.

The API tab of the Magento New Integration form, with callouts to set Resource Access to All and then click Save
The API tab, with Resource Access set to All before saving.

To grant less than that, set Resource Access to Custom and tick only what your agent needs:

  • Sales / Orders (read and write). Read covers order lookups; write covers cancel, hold, unhold, and order notices.

  • Sales / Invoices, Sales / Orders / Actions / Credit Memos, and Sales / Credit Memos. A refund is a credit memo raised against the order's invoice, and Magento splits it across two separate resources: the Orders action (Sales > Operations > Orders > Actions > Credit Memos) lets the agent issue the refund, and the separate top-level Credit Memos resource (Sales > Operations > Credit Memos) lets it read the created memo back to confirm the money moved. Grant both, or the agent can issue a refund it then reports as failed because it cannot read it back. Skip all three if you don't want the agent issuing refunds.

  • Sales / Shipments (read), for shipment status and tracking numbers.

  • Catalog / Products and Catalog / Inventory (read), for product and stock lookups.

Grant read-only if you only want lookups. Granting a resource does not turn an action on. You choose that later, per action.

3

Activate the integration and copy the four values

Back on the Integrations list, the integration you saved shows as Inactive. Click Activate.

The Magento Integrations list with the newly saved integration showing as Inactive and a callout on its Activate link
The saved integration, waiting to be activated.

Magento lists the API resources the integration is asking for. Read the list, then click Allow.

The Magento approval pop-up listing the requested API resources in a tree, with a callout on the Allow button
Magento's approval screen, listing the requested resources.

Magento now shows the Integration Tokens for Extensions pop-up. It holds four masked values: Consumer Key, Consumer Secret, Access Token and Access Token Secret. Copy all four, then click Done. A person approves this in the browser.

The Magento Integration Tokens for Extensions pop-up with the four values masked, callouts to copy all four and then click Done
The Integration Tokens pop-up with all four values.
4

Paste the four values into eesel

In the eesel dashboard, ask the chat to connect your Magento store. It asks for your store base URL first, including https:// and no trailing path. Then it opens a secure form with one field for each of the four values.

A secure form in the dashboard chat with empty fields for Consumer Key, Consumer Secret, Access Token and Access Token Secret, and a Save securely button
The secure form, with a field for each of the four Magento values.

Paste each value exactly as Magento shows it, with no extra spaces, and click Save securely. The values go straight to eesel, never into the chat, and the form expires in 30 minutes. This part is a human step. An AI agent running the setup waits for a person to paste the values in. It waits for the connection status to change, and does not retry.

The same secure form with all four values filled in and masked, ready to save securely
The form filled in, with the values masked.

eesel makes one test call to your store. Your agent then confirms the store is connected, and Magento appears in the left sidebar with your store URL.

Check it worked. The Magento integration page reads Connected with your store URL. From a terminal, eesel status shows the integration as connected with its source counts. If the connection reads needs reconnect, the values did not authenticate, so work through the Troubleshooting notes below and reconnect.

5

Put it to work

Connecting alone does not start your agent. It needs an automation first.

Tell your agent when to use the store data. That goes in the instructions of an automation on your helpdesk, Slack or chat bubble. Then set each action to run on its own, ask you first, or stay off. Most stores keep refunds and cancellations on approval.

On a Magento storefront the chat bubble needs a wrapped snippet. That snippet, and why Magento needs it, is on the Magento overview.

Two limits:

  • Orders. An order is found by its exact order number or by the email address on it. There is no free-text order search, and Magento matches an order number literally, so a mistyped number finds nothing.

  • Stock. A stock check reads one product at a time and needs that product's exact SKU. Your written content, such as a returns policy, is not part of Magento at all.

Why four credentials

Magento 2.4.4 and newer, released in 2022, checks each request against all four values, not the Access Token alone. One token on its own is refused.

Some older eesel connections were made with only an access token. Those keep working, so reconnect only when the connection stops working. Reconnecting uses all four values from the same integration.

Troubleshooting

The connection reads "needs reconnect", or it keeps failing
  • Check the Store URL is exact, including https://, with no trailing path.

  • Make sure the integration is Activated in Magento, not only saved.

  • Confirm you pasted all four values, and that every one came from the same integration. The Consumer Secret and the Access Token Secret are easy to mix up. Re-copy both from the Integration Tokens screen in Magento.

It worked, then every Magento read started failing

Re-activating the integration in Magento Admin issues a new set of four values. The old ones stop working at that moment. Ask your agent to reconnect Magento, and paste the new four values into the secure form it opens.

Connected, but your agent cannot find an order or a lookup comes back empty

The integration needs read access to the matching resource. That is Sales / Orders for order lookups, Sales / Shipments for tracking, and Catalog / Products plus Catalog / Inventory for stock. Then check the identifier, because Magento matches it literally. Look the customer's orders up by their email address and compare the order number against that list.

A refund, cancel, hold or unhold fails

A refund needs the Invoices read resource and both Credit Memos resources: Sales > Operations > Orders > Actions > Credit Memos to issue the refund and the top-level Sales > Operations > Credit Memos to read it back and confirm the money moved. Grant only one and the agent can move the money but reports the refund as failed. It also needs an invoice on the order to refund against, and only refunds orders paid by an offline method (check, bank transfer, cash on delivery); a card or other online-gateway order is refused, because that refund has to be issued in the Magento admin to reach the customer's account. Cancel, hold, unhold and order notices need write access on Sales / Orders. The order also has to be in a state that allows it. You cannot cancel an order that already shipped, or release a hold on an order that is not on hold.

A write action did not happen

If that action is set to ask you first, it is waiting on a person. Approve it and it runs.

Last updated