Get Started with the Catalog Service

After the Catalog Service is enabled, you can access the service and use it to retrieve catalog data, such as product and category information, from your Adobe Commerce instance. The service is available as a GraphQL API that you can access from the Commerce Admin or from any frontend application that supports GraphQL queries.

Access the service

The Catalog Service is available as a GraphQL API that you can access from the Commerce Admin or from any frontend application that supports GraphQL queries. The service is available in both SaaS and PaaS environments.

[PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects (Adobe-managed PaaS infrastructure) and on-premises projects only."}

[SaaS only]{class="badge positive" title="Applies to Adobe Commerce as a Cloud Service and Adobe Commerce Optimizer projects only (Adobe-managed SaaS infrastructure)."}

URL structure for SaaS endpoints

https://<region>-<environment>.api.commerce.adobe.com/<tenantId>/graphql

For details about using the Catalog Service GraphQL API, see the Catalog Service for Adobe Commerce Guide in the Adobe Commerce Developer documentation.

Integrate with a headless storefront or third-party services

To integrate with a headless storefront, you must update the storefront configuration to enable communication between the storefront and the Catalog Service to retrieve product and category data.

If you are using Adobe Commerce storefront on Edge Delivery Services, add the Catalog Service endpoint to the storefront configuration. For details, see the Edge Delivery Services documentation.

For other integrations, see the project setup documentation for details on how to configure integrations between the service and backend data sources.

Firewall configuration

To allow Catalog Service through a firewall, add commerce.adobe.io to the allowlist.

Catalog Service and API Mesh

The API Mesh for Adobe Developer App Builder enables developers to integrate private or third-party APIs and other interfaces with Adobe products using Adobe IO.

See the Catalog Service and API Mesh topic for installation and configuration details.

Use the Data Management Dashboard

Use the Data Management Dashboard to monitor data synchronization between the Catalog Service and your Adobe Commerce instance. The dashboard provides insights into the data transfer process, including the status of data exports and a list of synced products.