Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Adobe Commerce (Magento)

Scalekit connector
Open markdown

The Adobe Commerce (Magento) connector lets your AI agent act in each user's Adobe Commerce (Magento) account. Each user connects their own Adobe Commerce (Magento) access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 29 tools.

Tools
29
What they doRead · write · destructive
14 · 12 · 314 read12 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Adobe Commerce (Magento) connection

    In AgentKit > Connections, create an Adobe Commerce (Magento) connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'adobecommerce'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Adobe Commerce (Magento):', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'adobecommerce_categories_tree_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Adobe Commerce (Magento) credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • adobecommerce_categories_tree_getGet the category tree from a root category down to a depth.Read-only

    Get Category Tree

    Get the category tree from a root category down to a depth. Returns the root category with id, name, is_active, position, level, product_count and nested children_data. Use adobecommerce_categories_tree_get to browse categories and find IDs.

    Inputs

    depthinteger
    How many levels to return. Example: 3
    root_category_idinteger
    Category to start from; defaults to the store's root. Example: 2
  • adobecommerce_category_products_listList the products assigned to a category.Read-only

    List Category Products

    List the products assigned to a category. Returns an array of links with sku, position and category_id. Use adobecommerce_category_products_list to see a category's products. Use adobecommerce_category_product_assign to add one.

    Inputs

    category_idintegerrequired
    Category ID. Example: 4
  • adobecommerce_customer_getGet one customer by ID.Read-only

    Get Customer

    Get one customer by ID. Returns id, email, firstname, lastname, group_id, website_id, store_id, addresses, default_billing and default_shipping. Use adobecommerce_customer_get when you know the ID. Use adobecommerce_customers_search to find it.

    Inputs

    customer_idintegerrequired
    Customer ID. Example: 7
  • adobecommerce_inventory_source_items_listSearch per-source inventory records (Multi-Source Inventory) with one filter, sorting and paging.Read-only

    Search Inventory Source Items

    Search per-source inventory records (Multi-Source Inventory) with one filter, sorting and paging. Returns items[], search_criteria and total_count. Each item has sku, source_code, quantity and status. Use adobecommerce_inventory_source_items_list to see stock by warehouse. Use adobecommerce_inventory_source_items_update to change it.

    Inputs

    condition_typestring
    Comparison: eq (default), neq, like, nlike, in, nin, gt, lt, gteq, lteq, from, to, null, notnull or finset. Example: likeone of eqneqlikenlikeinningtltgteqlteqfromtonullnotnullfinset
    current_pageinteger
    Page number, starting at 1. Example: 1default 1
    filter_fieldstring
    Field to filter on. Example: sku
    filter_valuestring
    Value to compare; with condition_type like, use % as a wildcard; with in, a comma-separated list. Example: 24-MB01
    page_sizeinteger
    Results per page. Keep it small: without it Commerce returns every match. Example: 20default 20
    sort_directionstring
    ASC or DESC. Example: DESCone of ASCDESC
    sort_fieldstring
    Field to sort by. Example: quantity
  • adobecommerce_invoices_listSearch invoices with one filter (for example order_id or state), sorting and paging.Read-only

    Search Invoices

    Search invoices with one filter (for example order_id or state), sorting and paging. Returns items[], search_criteria and total_count. Each invoice has entity_id, increment_id, order_id, state, grand_total and created_at. Use adobecommerce_invoices_list to check billing for orders.

    Inputs

    condition_typestring
    Comparison: eq (default), neq, like, nlike, in, nin, gt, lt, gteq, lteq, from, to, null, notnull or finset. Example: likeone of eqneqlikenlikeinningtltgteqlteqfromtonullnotnullfinset
    current_pageinteger
    Page number, starting at 1. Example: 1default 1
    filter_fieldstring
    Field to filter on. Example: order_id
    filter_valuestring
    Value to compare; with condition_type like, use % as a wildcard; with in, a comma-separated list. Example: 42
    page_sizeinteger
    Results per page. Keep it small: without it Commerce returns every match. Example: 20default 20
    sort_directionstring
    ASC or DESC. Example: DESCone of ASCDESC
    sort_fieldstring
    Field to sort by. Example: created_at
  • adobecommerce_order_comments_listList the status history comments of an order.Read-only

    List Order Comments

    List the status history comments of an order. Returns items[] with comment, status, created_at, is_customer_notified and is_visible_on_front. Use adobecommerce_order_comments_list to read an order's history. Use adobecommerce_order_comment_add to add a comment.

    Inputs

    order_idintegerrequired
    Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
  • adobecommerce_order_getGet one order by entity ID.Read-only

    Get Order

    Get one order by entity ID. Returns the order with increment_id, state, status, totals, customer, billing_address, items, payment and shipping assignments. Use adobecommerce_order_get for full order details. Use adobecommerce_orders_list to find the entity ID from an increment_id.

    Inputs

    order_idintegerrequired
    Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42