IntegrationsMagento

Installation

Connect, edit and test a Magento store, then use Copilot to configure order tracking and other automations.

Connect Magento Open Source or Adobe Commerce on-premises/PaaS to Octocom, verify access, then tell Copilot what the bot should do. Adobe Commerce as a Cloud Service uses a different API and authentication system; this connector is for the traditional Magento REST API.

1. Create and activate a Magento integration

In Magento Admin, open System -> Extensions -> Integrations (called System -> Integrations in some versions), then Add New Integration. Name it Octocom.

Under API, select the resources your automations need. For read-only order tracking, enable Sales -> Orders and Sales -> Shipments. Permission labels and nesting can differ by Magento version. You do not need to grant access to unrelated resources. Magento's resource permissions may authorize more than read-only operations; keep your Python action read-only unless you explicitly want it to make changes.

Save, activate the integration and approve its requested resources. Copy its Consumer key, Consumer secret, Access token and Access token secret securely. Do not put them in chat messages, workflow instructions or Python source code.

If you change permissions later, reauthorize/reactivate the integration as required by your Magento version, then retest in Octocom. If permission changes are not taking effect, check Magento's cache and deployment configuration with your store administrator.

2. Save and test in Octocom

Open Settings -> Integrations -> Magento 2 -> Set up connection.

Enter:

FieldWhat to enter
Store URLYour store's base URL, including any required installation or language path prefix. For example, https://shop.example.com/fr. Do not append /rest/V1.
Consumer key / secretThe OAuth credentials from Magento.
Access token / secretThe token pair from Magento.
Store ID (Advanced, optional)The numeric store ID when an automation must be limited to one store in a multi-store installation. This is different from a URL path or store-view code.
Bearer mode (Advanced)Leave off for normal OAuth authentication. Enable only if your Magento administrator confirms that integration access tokens can be used as standalone Bearer tokens.

Click Save and test. Octocom makes bounded, read-only API requests. It does not change orders or require an existing order to verify access.

  • Orders accessible: the connection can be saved.
  • Shipments inaccessible: the connection can still be saved, with a warning. Order lookup works, but shipment tracking needs the missing access fixed.
  • Orders inaccessible: the new values are not saved. An existing connection remains unchanged.

The test checks API access, not whether a particular customer order exists or whether a numeric store ID is the right one. Test an order from the intended store when configuring the automation.

3. Configure what your bot should do

Connecting Magento makes its credentials available to Python automations. A new connection installs standard Python order lookup actions and an Orders sidebar widget when there is no existing action or widget configuration to preserve. Reconnecting preserves existing configuration, including inactive actions and widgets.

Order tracking runs through Python. Connecting the store does not create workflows; enable the appropriate action in a workflow and instruct the bot to call it.

Ask Copilot, for example:

"Set up live order tracking for my connected Magento store. Ask for the email used to place the order, accept an optional order number, and return the status, items, totals and available shipment tracking. Test the action and connect it to a workflow."

Copilot can inspect and customize the installed Python actions or create one using get_integration_credentials(context), test it, and enable it in a workflow. No separate copy of your credentials into Secrets is needed. Read the Magento automation playbook for the implementation patterns used by Copilot and other agents.

Edit or retest later

Reopen the Magento integration. Its Settings tab contains the saved values. Credentials are masked; use the reveal button only when needed.

  • Edit the fields, then use Save and test to verify and replace the saved configuration.
  • Use Test connection without edits to check the currently saved credentials again.
  • Unsaved edits do not affect the live connection. Save and test them before retesting the saved connection.
  • Disconnect removes the connection. Automations using it may stop working.

Troubleshooting

ResultWhat to check
Authentication or permission deniedConfirm all credentials belong to the same active Magento integration, the authentication mode is correct, the complete URL is preserved, and the integration has the relevant resource permission.
Orders pass, shipments failGrant access to Sales -> Shipments, reactivate as required, and retest. Missing access does not mean a parcel has not shipped.
Redirect or API not foundEnter the final store base URL. Keep required prefixes such as an installation subdirectory or language path. Do not assume every store needs /fr.
Network errorCheck store availability, TLS configuration and any firewall/IP allowlist. Octocom's connection test uses its stable HTTP proxy egress.
API passes but a customer's order is not foundVerify the order email, real order number and numeric store scope. This is separate from connection validation.

For platform details, see Adobe's REST API overview and OAuth authentication guide.

On this page