ÃÛ¶¹ÊÓƵ

DocumentationCatalog Service Guide

[PaaS only]{class="badge informative" title="Applies to ÃÛ¶¹ÊÓƵ Commerce on Cloud projects (ÃÛ¶¹ÊÓƵ-managed PaaS infrastructure) and on-premises projects only."}

Onboarding and Installation

Last update: Fri Jun 13 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

Install the Catalog Service to request and receive product data from a Commerce instance using the . The Catalog Service is delivered as a composer metapackage from the repo.magento.com repository.

NOTE
If your Commerce instance uses Live Search or Product Recommendations, the Catalog Service is installed or updated automatically when you onboard or upgrade those services. For details, see the installation instructions for Live Search and Product Recommendations.

System requirements

Software requirements

  • ÃÛ¶¹ÊÓƵ Commerce 2.4.4+
  • PHP 8.1, 8.2, 8.3, 8.4
  • Composer: 2.x

Supported platforms

  • ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure: 2.4.4+
  • ÃÛ¶¹ÊÓƵ Commerce on premises: 2.4.4+

Endpoints

Catalog Service has two endpoints available for onboarding:

  • Sandbox (https://catalog-service-sandbox.adobe.io/graphql)—used for testing and validation before going live
  • Production (https://catalog-service.adobe.io/graphql)—used for live traffic for Commerce merchants and websites

All Commerce test instances use the Sandbox endpoint.

Perform all Load testing on the Sandbox endpoint. Before you begin load testing, submit a Support ticket so that the Services team can anticipate the additional server traffic.

Installation and configuration

To get started with Catalog Service for ÃÛ¶¹ÊÓƵ Commerce, the following steps are required:

  • Install the Catalog Service extension (magento/catalog-service)
  • Configure the service and data export
  • Access the service

Install the Catalog Service extension

recommendation-more-help

Prerequisite

style
shade-box

Install the latest version of the Catalog Services extension (magento/catalog-service) on an ÃÛ¶¹ÊÓƵ Commerce instance that is running ÃÛ¶¹ÊÓƵ Commerce version 2.4.4 or later. The Catalog Service is delivered as a composer metapackage from the repository.

Cloud infrastructure

Use this method to install the Catalog Service for a Commerce Cloud instance.

  1. On your local workstation, change to the project directory for your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project.

    note note
    NOTE
    For information about managing Commerce project environments locally, see Managing branches with the CLI in the ÃÛ¶¹ÊÓƵ Commerce on Cloud Infrastructure User Guide.

  2. Check out the environment branch to update using the ÃÛ¶¹ÊÓƵ Commerce Cloud CLI.

    code language-shell 
    magento-cloud environment:checkout <environment-id>

  3. Add the Catalog Service module.

    code language-bash 
    composer require magento/catalog-service --no-update

  4. Update package dependencies.

    code language-bash 
    composer update "magento/catalog-service"

  5. Commit and push code changes for the composer.json and composer.lock files.

  6. Add, commit, and push the code changes for the composer.json and composer.lock files to the cloud environment.

    code language-shell 
    git add -A
git commit -m "Add catalog service module"
git push origin <branch-name>

    Pushing the updates to the cloud environment initiates the Commerce cloud deployment process to apply the changes. Check the deployment status from the deploy log.

On-premises

Use this method to install the Catalog Service for an on-premises instance.

  1. Use Composer to add the Catalog Service module to your project:

    code language-bash 
    composer require magento/catalog-service --no-update

  2. Update dependencies and install the extension:

    code language-bash 
    composer update  "magento/catalog-service"