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
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Adobe Commerce (Magento) connection
In AgentKit > Connections, create an Adobe Commerce (Magento) connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'adobecommerce'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'adobecommerce_categories_tree_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "adobecommerce"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Adobe Commerce (Magento):", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="adobecommerce_categories_tree_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_tooladobecommerce_categories_tree_getGet the category tree from a root category down to a depth.Read-onlyGet 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-onlyList 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-onlyGet 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_customers_searchSearch customers with one filter (for example email, firstname or group_id), sorting and paging.Read-onlySearch Customers
Search customers with one filter (for example email, firstname or group_id), sorting and paging. Returns items[], search_criteria and total_count. Each customer has id, email, firstname, lastname, group_id, website_id, addresses and created_at. Use adobecommerce_customers_search to find a customer. Use adobecommerce_customer_get for one customer by ID.
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: email
filter_valuestring- Value to compare; with condition_type like, use % as a wildcard; with in, a comma-separated list. Example: jane@example.com
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_inventory_source_items_listSearch per-source inventory records (Multi-Source Inventory) with one filter, sorting and paging.Read-onlySearch 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-onlySearch 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-onlyList 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-onlyGet 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
adobecommerce_orders_listSearch orders with one filter (for example status, customer_email or created_at), sorting and paging.Read-onlySearch Orders
Search orders with one filter (for example status, customer_email or created_at), sorting and paging. Returns items[], search_criteria and total_count. Each order has entity_id, increment_id, state, status, customer_email, grand_total, created_at and items. Use adobecommerce_orders_list to find orders. Use adobecommerce_order_get for one order by entity ID.
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: status
filter_valuestring- Value to compare; with condition_type like, use % as a wildcard; with in, a comma-separated list. Example: pending
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_product_getGet one product by SKU.Read-onlyGet Product
Get one product by SKU. Returns the product with id, sku, name, price, status, visibility, type_id, weight, extension_attributes (stock, category links) and custom_attributes. Use adobecommerce_product_get when you know the SKU. Use adobecommerce_products_list to search.
Inputs
skustringrequired- Product SKU. Example: 24-MB01
adobecommerce_products_listSearch catalog products with one filter, sorting and paging.Read-onlySearch Products
Search catalog products with one filter, sorting and paging. Returns items[], search_criteria and total_count. Each product has id, sku, name, price, status, visibility, type_id and custom_attributes. Use adobecommerce_products_list to find products by name, SKU or attribute. Use adobecommerce_product_get for one product by SKU.
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: name
filter_valuestring- Value to compare; with condition_type like, use % as a wildcard; with in, a comma-separated list. Example: %bag%
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: updated_at
adobecommerce_shipments_listSearch shipments with one filter (for example order_id), sorting and paging.Read-onlySearch Shipments
Search shipments with one filter (for example order_id), sorting and paging. Returns items[], search_criteria and total_count. Each shipment has entity_id, increment_id, order_id, items, tracks and created_at. Use adobecommerce_shipments_list to check fulfillment and tracking.
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_stock_item_getGet the legacy stock item of a product: quantity, in-stock flag and stock settings.Read-onlyGet Stock Item
Get the legacy stock item of a product: quantity, in-stock flag and stock settings. Returns item_id, product_id, stock_id, qty, is_in_stock, min_qty, backorders and manage_stock. Use adobecommerce_stock_item_get to check stock for a SKU. Use adobecommerce_inventory_source_items_list for per-source quantities.
Inputs
skustringrequired- Product SKU. Example: 24-MB01
adobecommerce_store_configs_getGet the configuration of the store views: base URLs, locale, currency, timezone and weight unit.Read-onlyGet Store Configuration
Get the configuration of the store views: base URLs, locale, currency, timezone and weight unit. Returns an array of store configs with id, code, website_id, locale, base_currency_code, default_display_currency_code, timezone, weight_unit and base URLs. Use adobecommerce_store_configs_get to check the store's currency, locale and URLs.
Inputs
store_codesstring- Only these store view codes, comma-separated. Example: default
adobecommerce_category_createCreate a category under a parent category.WriteCreate Category
Create a category under a parent category. Returns the created category with id, parent_id, name, path and level. Use adobecommerce_category_create to add a category. Use adobecommerce_categories_tree_get to find the parent ID.
Inputs
namestringrequired- Category name. Example: Travel Bags
parent_idintegerrequired- Parent category ID (2 is usually Default Category). Example: 2
include_in_menuboolean- Show in the storefront menu. Example: true
is_activeboolean- Enable the category. Example: true
positioninteger- Position among siblings. Example: 1
adobecommerce_category_product_assignAssign a product to a category, or change its position there.WriteAssign Product to Category
Assign a product to a category, or change its position there. Returns true on success. Use adobecommerce_category_product_assign to put a product in a category.
Inputs
category_idintegerrequired- Category ID. Example: 4
skustringrequired- Product SKU. Example: 24-MB01
positioninteger- Position in the category. Example: 1
adobecommerce_customer_createCreate a customer account without a password; the customer can set one with Forgot Password.WriteCreate Customer
Create a customer account without a password; the customer can set one with Forgot Password. Returns the created customer with id. Use adobecommerce_customer_create to add a customer. Use adobecommerce_customers_search first to avoid a duplicate email.
Inputs
emailstringrequired- Email. Example: jane@example.com
firstnamestringrequired- First name. Example: Jane
lastnamestringrequired- Last name. Example: Doe
addressesarray- Addresses, each with firstname, lastname, street (array), city, region {region_code, region_id}, postcode, country_id and telephone; flag one with default_billing / default_shipping. Example: [{"firstname": "Jane", "lastname": "Doe", "street": ["123 Main St"], "city": "Austin", "region": {"region_code": "TX", "region_id": 57}, "postcode": "78701", "country_id": "US", "telephone": "5125550100", "default_billing": true, "default_shipping": true}]
group_idinteger- Customer group ID (1 General, 2 Wholesale, 3 Retailer by default). Example: 1
website_idinteger- Website ID. Example: 1
adobecommerce_customer_updateUpdate a customer's email, name, group or addresses; send the current email, first and last name even if unchanged.WriteUpdate Customer
Update a customer's email, name, group or addresses; send the current email, first and last name even if unchanged. Returns the updated customer. Use adobecommerce_customer_update after adobecommerce_customer_get. Addresses sent replace the customer's address list.
- Idempotent
Inputs
customer_idintegerrequired- Customer ID. Example: 7
emailstringrequired- Email (current or new). Example: jane@example.com
firstnamestringrequired- First name (current or new). Example: Jane
lastnamestringrequired- Last name (current or new). Example: Doe
addressesarray- Addresses, each with firstname, lastname, street (array), city, region {region_code, region_id}, postcode, country_id and telephone; flag one with default_billing / default_shipping. Example: [{"firstname": "Jane", "lastname": "Doe", "street": ["123 Main St"], "city": "Austin", "region": {"region_code": "TX", "region_id": 57}, "postcode": "78701", "country_id": "US", "telephone": "5125550100", "default_billing": true, "default_shipping": true}]
group_idinteger- Customer group ID (1 General, 2 Wholesale, 3 Retailer by default). Example: 1
website_idinteger- Website ID. Example: 1
adobecommerce_inventory_source_items_updateSet the quantity and stock status of products at inventory sources (Multi-Source Inventory); records are created or replaced.WriteUpdate Inventory Source Items
Set the quantity and stock status of products at inventory sources (Multi-Source Inventory); records are created or replaced. Returns an empty response on success. Use adobecommerce_inventory_source_items_update to change stock. Single-source stores use source_code default.
- Idempotent
Inputs
source_itemsarrayrequired- Records, each {"sku": ..., "source_code": ..., "quantity": ..., "status": 1 in stock or 0 out of stock}. Example: [{"sku": "24-MB01", "source_code": "default", "quantity": 100, "status": 1}]
adobecommerce_order_comment_addAdd a comment to an order's status history, optionally visible on the storefront.WriteAdd Order Comment
Add a comment to an order's status history, optionally visible on the storefront. Returns true on success. Use adobecommerce_order_comment_add for internal notes or customer-visible updates.
Inputs
commentstringrequired- Comment text. Example: Customer called to confirm the address
is_customer_notifiedintegerrequired- 1 if the customer was notified, 0 otherwise. Example: 0one of
01default0 is_visible_on_frontintegerrequired- 1 to show the comment to the customer in their account, 0 to keep it internal. Example: 0one of
01default0 order_idintegerrequired- Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
statusstring- Order status to record with the comment. Example: processing
adobecommerce_order_holdPut an order on hold.WriteHold Order
Put an order on hold. Returns true on success. Use adobecommerce_order_hold to pause processing. Use adobecommerce_order_unhold to release it.
Inputs
order_idintegerrequired- Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
adobecommerce_order_invoiceCreate an invoice for an order, all items or some, optionally capturing the payment online.WriteInvoice Order
Create an invoice for an order, all items or some, optionally capturing the payment online. Returns the new invoice ID. Use adobecommerce_order_invoice to bill an order. capture true charges the customer's payment method.
Inputs
order_idintegerrequired- Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
captureboolean- Capture the payment online when the payment method supports it. Example: false
itemsarray- Items to invoice, each {"order_item_id": ..., "qty": ...}; omit to invoice everything. Example: [{"order_item_id": 101, "qty": 1}]
notifyboolean- Email the invoice to the customer. Example: false
adobecommerce_order_shipCreate a shipment for an order, all items or some, with tracking numbers; can email the customer.WriteShip Order
Create a shipment for an order, all items or some, with tracking numbers; can email the customer. Returns the new shipment ID. Use adobecommerce_order_ship to fulfil an order. Get order item IDs from adobecommerce_order_get (items[].item_id).
Inputs
order_idintegerrequired- Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
commentstring- Shipment comment. Example: Shipped from warehouse B
itemsarray- Items to ship, each {"order_item_id": ..., "qty": ...}; omit to ship everything. Example: [{"order_item_id": 101, "qty": 1}]
notifyboolean- Email the customer about the shipment. Example: false
tracksarray- Tracking numbers, each {"track_number": ..., "title": ..., "carrier_code": ...}. Example: [{"track_number": "1Z999AA10123456784", "title": "UPS", "carrier_code": "ups"}]
adobecommerce_order_unholdRelease an order from hold.WriteRelease Order Hold
Release an order from hold. Returns true on success. Use adobecommerce_order_unhold on an order held with adobecommerce_order_hold.
Inputs
order_idintegerrequired- Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
adobecommerce_product_createCreate a catalog product.WriteCreate Product
Create a catalog product. Returns the created product with id and all saved fields. Use adobecommerce_product_create to add a simple or virtual product. Use adobecommerce_inventory_source_items_update to set its stock.
Inputs
attribute_set_idintegerrequired- Attribute set ID; 4 is the Default set. Example: 4default
4 namestringrequired- Product name. Example: Weekender Duffle
skustringrequired- Unique SKU. Example: SK-TEST-BAG-01
type_idstringrequired- simple, virtual, configurable, bundle, grouped or downloadable. Example: simpleone of
simplevirtualconfigurablebundlegroupeddownloadabledefaultsimple custom_attributesarray- Other attributes, each {"attribute_code": ..., "value": ...}, such as description, url_key or category_ids. Example: [{"attribute_code": "description", "value": "<p>Roomy duffle bag</p>"}]
pricenumber- Price. Example: 34
statusinteger- 1 enabled, 2 disabled. Example: 1one of
12 visibilityinteger- 1 Not visible individually, 2 Catalog, 3 Search, 4 Catalog and search. Example: 4one of
1234 weightnumber- Weight. Example: 1
adobecommerce_product_updateUpdate a product's name, price, status, visibility, weight or attributes by SKU.WriteUpdate Product
Update a product's name, price, status, visibility, weight or attributes by SKU. Returns the updated product. Use adobecommerce_product_update to change product data. Use adobecommerce_inventory_source_items_update for stock.
- Idempotent
Inputs
skustringrequired- Product SKU. Example: 24-MB01
custom_attributesarray- Other attributes, each {"attribute_code": ..., "value": ...}, such as description, url_key or category_ids. Example: [{"attribute_code": "description", "value": "<p>Roomy duffle bag</p>"}]
namestring- New name. Example: Weekender Duffle Bag
pricenumber- Price. Example: 34
statusinteger- 1 enabled, 2 disabled. Example: 1one of
12 visibilityinteger- 1 Not visible individually, 2 Catalog, 3 Search, 4 Catalog and search. Example: 4one of
1234 weightnumber- Weight. Example: 1
adobecommerce_customer_deleteDelete a customer account.DestructiveDelete Customer
Delete a customer account. Returns true when deleted. Use adobecommerce_customer_delete to remove a customer for good; confirm the ID with adobecommerce_customer_get first.
- Idempotent
Inputs
customer_idintegerrequired- Customer ID. Example: 7
adobecommerce_order_cancelCancel an order that has not been invoiced or shipped.DestructiveCancel Order
Cancel an order that has not been invoiced or shipped. Returns true on success. Use adobecommerce_order_cancel to void an unpaid order; it can't be undone.
Inputs
order_idintegerrequired- Order entity ID (the id field, not the increment_id shown to shoppers). Example: 42
adobecommerce_product_deleteDelete a product by SKU.DestructiveDelete Product
Delete a product by SKU. Returns true when deleted. Use adobecommerce_product_delete to remove a product for good; set status 2 with adobecommerce_product_update to disable it instead.
- Idempotent
Inputs
skustringrequired- Product SKU. Example: 24-MB01
No tools match.