Onboarding and Installation
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.
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
Prerequisite
-
Access to install the extension. For key generation and obtaining the necessary rights, see Get your authentication keys. For cloud installations, see the Commerce on Cloud Infrastructure Guide
-
Access to the command line of the ÃÛ¶¹ÊÓÆµ Commerce application server.
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.
Use this method to install the Catalog Service for a Commerce Cloud instance.
-
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. -
Check out the environment branch to update using the ÃÛ¶¹ÊÓÆµ Commerce Cloud CLI.
code language-shell magento-cloud environment:checkout <environment-id>
-
Add the Catalog Service module.
code language-bash composer require magento/catalog-service --no-update
-
Update package dependencies.
code language-bash composer update "magento/catalog-service"
-
Commit and push code changes for the
composer.json
andcomposer.lock
files. -
Add, commit, and push the code changes for the
composer.json
andcomposer.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.
Use this method to install the Catalog Service for an on-premises instance.
-
Use Composer to add the Catalog Service module to your project:
code language-bash composer require magento/catalog-service --no-update
-
Update dependencies and install the extension:
code language-bash composer update "magento/catalog-service"