How to Integrate Magento (Adobe Commerce) with Your Headless CMS

What is Magento (Adobe Commerce)?

Magento (Adobe Commerce) is Adobe’s commerce platform for building B2C and B2B storefronts, catalogs, checkout flows, customer accounts, promotions, and order operations. It’s used by mid-market and enterprise teams that need deep control over product catalogs, pricing rules, customer groups, inventory, and multi-store setups. Magento exposes REST and GraphQL APIs, which makes it practical to connect product data with content systems, frontends, search indexes, and internal tools.

Why integrate Magento (Adobe Commerce) with a headless CMS?

Commerce teams usually hit the same wall: Magento is great at catalog, pricing, inventory, carts, and orders, but the content around the product often needs a different workflow. A merchandising team may want to publish a holiday gift guide, update a PDP buying guide, localize care instructions, or test brand storytelling without waiting for a developer to edit theme templates or product attributes directly in Magento.

Architecture overview

A typical integration starts with editors publishing structured product content in Sanity Studio. That content is structured in the Content Lake with references to product SKUs, campaign modules, locale-specific copy, SEO fields, and rich product storytelling. When a document is published, a Sanity webhook fires with the document ID, or a Function runs directly on the content mutation. The sync code uses @sanity/client and GROQ to fetch only the fields Magento (Adobe Commerce) needs, such as sku, shortDescription, description, metaTitle, metaDescription, and custom landing-page fields. The integration then calls Magento’s REST API, usually PUT /rest/V1/products/{sku}, with an Adobe Commerce admin access token. For example, it can map Sanity fields to Magento product attributes like short_description, description, meta_title, and custom_attributes. The frontend can then render the result from Magento, Sanity, or both: Magento supplies price and availability, while Sanity supplies editorial content, campaign modules, and AI-ready structured data. For teams that don’t want to run a separate server, Functions can handle the server-side API call without extra infrastructure.

Common use cases

Step-by-step integration

1. 1

   Set up Magento (Adobe Commerce) API access

   In the Magento admin, create an integration under System > Extensions > Integrations, assign catalog permissions, activate it, and copy the access token. For local testing, confirm the REST API is reachable at https://your-store.com/rest/V1/products/{sku}.

2. 2

   Install the client libraries

   In your sync project or Function, install @sanity/client and a request library such as axios. Keep MAGENTO_BASE_URL, MAGENTO_ADMIN_TOKEN, SANITY_PROJECT_ID, SANITY_DATASET, and SANITY_API_VERSION in environment variables.

3. 3

   Model Magento-linked content in Sanity Studio

   Create a product content schema with fields such as sku, title, shortDescription, body, metaTitle, metaDescription, locale, campaignModules, and relatedGuides. The sku field is the stable join key between Sanity documents and Magento products.

4. 4

   Create the sync trigger

   Add a Sanity webhook that fires on publish for product content documents, or use Functions to react to mutations directly. Include the document ID in the payload so your handler can fetch the current published version.

5. 5

   Map Sanity fields to Magento attributes

   Use GROQ to fetch only the fields Magento needs, then call Magento’s REST API. Common mappings include shortDescription to short_description, body text to description, metaTitle to meta_title, and metaDescription to meta_description.

6. 6

   Test the storefront experience

   Publish a test product content document, verify the Magento API response, inspect the product in the Magento admin, and load the PDP. Test edge cases too: missing SKU, unpublished content, invalid token, and store-view-specific content.

How Sanity + Magento (Adobe Commerce) works

CMS approaches to Magento (Adobe Commerce)

Keep building

Explore related integrations to complete your content stack.