> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Adobe Commerce

> How to set up the Adobe Commerce connector, plus the actions that are available.

![Adobe Commerce](https://stackone-logos.com/api/adobe/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/adobe_commerce/changelog.md)

[61 actions](#actions) · 3 auth methods

E-Commerce

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [User Credentials (Admin) · Connector Profile](https://docs.stackone.com/connectors/adobe_commerce/guides/connector-profile/user-credentials-admin.md)

> [card] [Integration Access Token · Connector Profile](https://docs.stackone.com/connectors/adobe_commerce/guides/connector-profile/integration-access-token.md)
>
> Uses the Access Token of an Adobe Commerce integration. It does not expire until the integration is reauthorized.

> [card] [Adobe Commerce as a Cloud Service · Connector Profile](https://docs.stackone.com/connectors/adobe_commerce/guides/connector-profile/adobe-commerce-as-a-cloud-service.md)
>
> For Adobe Commerce as a Cloud Service (SaaS) only. Uses an Adobe Developer Console OAuth Server-to-Server credential.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [User Credentials (Admin) · Link Account](https://docs.stackone.com/connectors/adobe_commerce/guides/link-account/user-credentials-admin.md)

> [card] [Integration Access Token · Link Account](https://docs.stackone.com/connectors/adobe_commerce/guides/link-account/integration-access-token.md)

> [card] [Adobe Commerce as a Cloud Service · Link Account](https://docs.stackone.com/connectors/adobe_commerce/guides/link-account/adobe-commerce-as-a-cloud-service.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Adobe Commerce as a Cloud Service

Integration Access Token

User Credentials (Admin)

No auth methods found

Scopes

Select all
|
Clear

Magento\_Backend::store

Magento\_Cart::manage

Magento\_Catalog::catalog\_inventory

Magento\_Catalog::categories

Magento\_Catalog::products

Magento\_Cms::block

Magento\_Cms::page

Magento\_Customer::customer

Magento\_Customer::delete

Magento\_Customer::group

Magento\_Customer::manage

Magento\_InventoryApi::source

Magento\_InventoryApi::stock\_source\_item\_assign

Magento\_Sales::actions\_view

Magento\_Sales::cancel

Magento\_Sales::comment

Magento\_Sales::invoice

Magento\_Sales::sales\_creditmemo

Magento\_Sales::sales\_invoice

Magento\_Sales::shipment

Magento\_SalesRule::quote

Magento\_Tax::manage\_tax

No scopes found

61 actions

ActionDescriptionRequired scopes

List Products`adobe_commerce_list_products`

Retrieve a list of products with filtering and pagination (ACL Magento\_Catalogproducts)

`Magento_Catalog::products`

Get Product By SKU`adobe_commerce_get_product`

Retrieve a specific product by SKU (ACL Magento\_Catalogproducts)

`Magento_Catalog::products`

Create Product`adobe_commerce_create_product`

Create a new product (ACL Magento\_Catalogproducts)

`Magento_Catalog::products`

Update Product`adobe_commerce_update_product`

Update an existing product (ACL Magento\_Catalogproducts)

`Magento_Catalog::products`

Delete Product`adobe_commerce_delete_product`

Delete a product by SKU (ACL Magento\_Catalogproducts)

`Magento_Catalog::products`

List Categories`adobe_commerce_list_categories`

Get category tree

`Magento_Catalog::categories`

Get Category`adobe_commerce_get_category`

Get category details

`Magento_Catalog::categories`

Create Category`adobe_commerce_create_category`

Create a new category

`Magento_Catalog::categories`

Update Category`adobe_commerce_update_category`

Update category information

`Magento_Catalog::categories`

Delete Category`adobe_commerce_delete_category`

Delete a category

`Magento_Catalog::categories`

List Customers`adobe_commerce_list_customers`

Retrieve a list of customers with filtering

`Magento_Customer::customer`

Get Customer`adobe_commerce_get_customer`

Retrieve a specific customer by ID

`Magento_Customer::customer`

Create Customer`adobe_commerce_create_customer`

Create a new customer account

Update Customer`adobe_commerce_update_customer`

Update customer information

`Magento_Customer::manage`

Delete Customer`adobe_commerce_delete_customer`

Delete a customer account

`Magento_Customer::delete`

List Customer Groups`adobe_commerce_list_customer_groups`

Get all customer groups (ACL Magento\_Customergroup)

`Magento_Customer::group`

Get Customer Group`adobe_commerce_get_customer_group`

Get specific customer group by ID (ACL Magento\_Customergroup)

`Magento_Customer::group`

Create Customer Group`adobe_commerce_create_customer_group`

Create new customer group (ACL Magento\_Customergroup)

`Magento_Customer::group`

Update Customer Group`adobe_commerce_update_customer_group`

Update an existing customer group by ID

`Magento_Customer::group`

Delete Customer Group`adobe_commerce_delete_customer_group`

Delete a customer group by ID

`Magento_Customer::group`

List Orders`adobe_commerce_list_orders`

Retrieve a list of orders with filtering

`Magento_Sales::actions_view`

Get Order`adobe_commerce_get_order`

Retrieve a specific order by ID

`Magento_Sales::actions_view`

Add Order Comment`adobe_commerce_create_order_comment`

Add a comment to an existing order. Requires orderId (integer — use list\_orders to find it) and a statusHistory object w\...

`Magento_Sales::comment`

Cancel Order`adobe_commerce_cancel_order`

Cancel an existing order

`Magento_Sales::cancel`

List Invoices`adobe_commerce_list_invoices`

List invoices with filters (ACL Magento\_Sales sales\_invoice)

`Magento_Sales::sales_invoice`

Get Invoice`adobe_commerce_get_invoice`

Get specific invoice by ID (ACL Magento\_Salessales\_invoice)

`Magento_Sales::sales_invoice`

Send Invoice Email`adobe_commerce_send_invoice_email`

Send invoice email to customer (ACL Magento\_Salessales\_invoice)

`Magento_Sales::sales_invoice`

Create Invoice`adobe_commerce_create_invoice`

Create an invoice for an order. Requires orderId (integer) as a path parameter. Optionally pass items (array of \{order\_i...

`Magento_Sales::invoice`

List Shipments`adobe_commerce_list_shipments`

List shipments with filters (ACL Magento\_Salesshipment)

`Magento_Sales::shipment`

Get Shipment`adobe_commerce_get_shipment`

Get specific shipment by ID (ACL Magento\_Salesshipment)

`Magento_Sales::shipment`

Create Shipment`adobe_commerce_create_shipment`

Create a shipment for an order. Requires an entity object containing order\_id (integer), items (array of \{order\_item\_id,...

`Magento_Sales::shipment`

List Credit Memos`adobe_commerce_list_credit_memos`

List credit memos with filters (ACL Magento\_Salescreditmemo)

`Magento_Sales::sales_creditmemo`

Get Credit Memo`adobe_commerce_get_credit_memo`

Retrieve a credit memo by its numeric id. Obtain ids by first calling list\_credit\_memos, or capture them from the respon...

`Magento_Sales::sales_creditmemo`

Create Credit Memo (Refund)`adobe_commerce_create_credit_memo`

Create a credit memo (refund) for an order. Requires a creditmemo object with order\_id (integer) and optionally items (a...

`Magento_Sales::sales_creditmemo`

Create Cart`adobe_commerce_create_cart`

Create a new shopping cart for the authenticated customer

`Magento_Cart::manage`

Get Cart`adobe_commerce_get_cart`

Retrieve cart details by ID

`Magento_Cart::manage`

Add Item To Cart`adobe_commerce_add_cart_item`

Add a product to the cart

`Magento_Cart::manage`

Update Cart Item`adobe_commerce_update_cart_item`

Update the quantity or product options of an existing cart item.

`Magento_Cart::manage`

Remove Cart Item`adobe_commerce_delete_cart_item`

Remove an item from the cart

`Magento_Cart::manage`

Get Stock Status`adobe_commerce_get_stock_status`

Get the legacy single-source stock status for a product by SKU (is it in stock? what quantity?). This uses the CatalogIn...

`Magento_Catalog::catalog_inventory`

List Source Items`adobe_commerce_list_source_items`

List multi-source inventory (MSI) source items — shows product quantities per warehouse/source. Filter by sku or source\_...

`Magento_InventoryApi::source`

Update Source Items`adobe_commerce_update_source_items`

Update inventory quantities at sources. Requires a sourceItems array where each item has sku (string — use list\_products...

`Magento_InventoryApi::stock_source_item_assign`

List CMS Pages`adobe_commerce_list_cms_pages`

Get all CMS pages (full standalone web pages like 'About Us', 'Home', 'Contact'). Pages have their own URL and are navig...

`Magento_Cms::page`

Get CMS Page`adobe_commerce_get_cms_page`

Get a specific CMS page

`Magento_Cms::page`

List CMS Blocks`adobe_commerce_list_cms_blocks`

Get all CMS blocks (reusable content snippets like banners, sidebars, footer widgets that are embedded within pages or l...

`Magento_Cms::block`

Get CMS Block`adobe_commerce_get_cms_block`

Get a specific CMS block

`Magento_Cms::block`

List Store Configurations`adobe_commerce_list_store_configs`

Get store configuration settings (locale, currency, timezone, base URLs, secure URLs). This returns the technical config...

`Magento_Backend::store`

List Websites`adobe_commerce_list_websites`

Get all websites in the Magento multi-site hierarchy. A website is the top level — each website contains one or more sto...

`Magento_Backend::store`

List Store Groups`adobe_commerce_list_store_groups`

Get all store groups (the middle level of Magento's hierarchy: Website > Store Group > Store View). Each store group bel...

`Magento_Backend::store`

List Store Views`adobe_commerce_list_store_views`

Get all store views (the lowest level of Magento's hierarchy: Website > Store Group > Store View). Each store view repre...

`Magento_Backend::store`

List Tax Rates`adobe_commerce_list_tax_rates`

Get all tax rates — the actual percentage rates applied to products (e.g., 8.25% for California). Each rate is tied to a...

`Magento_Tax::manage_tax`

List Tax Rules`adobe_commerce_list_tax_rules`

Get all tax rules — rules that combine tax rates with tax classes to determine which rate applies to which products/cust...

`Magento_Tax::manage_tax`

List Tax Classes`adobe_commerce_list_tax_classes`

Get all tax classes — categories that classify products (e.g., 'Taxable Goods', 'Shipping') or customers (e.g., 'Retail...

`Magento_Tax::manage_tax`

Generate Coupons`adobe_commerce_generate_coupons`

Generate coupon codes for a cart price rule. Requires a couponSpec object with rule\_id (integer — use list\_cart\_rules to...

`Magento_SalesRule::quote`

List Coupons`adobe_commerce_list_coupons`

Get all coupon codes

`Magento_SalesRule::quote`

Delete Coupon`adobe_commerce_delete_coupon`

Delete a coupon by ID

`Magento_SalesRule::quote`

List Cart Price Rules`adobe_commerce_list_cart_rules`

Get all cart price rules

`Magento_SalesRule::quote`

Get Cart Price Rule`adobe_commerce_get_cart_rule`

Get a specific cart price rule

`Magento_SalesRule::quote`

Create Cart Price Rule`adobe_commerce_create_cart_rule`

Create a new cart price rule (promotion). Requires a rule object with: name (string), is\_active (boolean), simple\_action...

`Magento_SalesRule::quote`

Update Cart Price Rule`adobe_commerce_update_cart_rule`

Update an existing cart price rule by ID. Requires ruleId (integer) as path parameter and a rule object with the fields...

`Magento_SalesRule::quote`

Delete Cart Price Rule`adobe_commerce_delete_cart_rule`

Delete a cart price rule by ID

`Magento_SalesRule::quote`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.