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.

NOTE
For Commerce solutions that use Adobe Commerce Optimizer or the Adobe Commerce Optimizer connector, use the Merchandising Services GraphQL API instead of the Catalog Service GraphQL API.

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."}

Environment
Endpoint
Testing
https://catalog-service-sandbox.adobe.io/graphql
Production
https://catalog-service.adobe.io/graphql

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

Environment
Endpoint
Testing
https://na1-sandbox.api.commerce.adobe.com/{{tenant-id}}/graphql
Production (Not available yet)
https://na1.api.commerce.adobe.com/{{tenant-id}}/graphql

URL structure for SaaS endpoints

https://<region>-<environment>.api.commerce.adobe.com/<tenantId>/graphql
  • <region> is the cloud region where your instance is deployed.
  • <environment> is the environment type, such as sandbox. If the environment is production, this value is omitted.
  • <tenantId> is the unique identifier for your organization’s specific instance within the Adobe Experience Cloud.

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.

Monitor and troubleshoot data export

The Commerce Admin provides tools for monitoring and troubleshooting data export from Commerce to connected services:

  • Data Management Dashboard—Monitor data synchronization between the Catalog Service and your Adobe Commerce instance. The dashboard shows overall sync status and lists all synced products.

  • Data Feed Sync Status page—Track the export status of all data feeds to ensure data consistency. This page alerts you to issues that occur during the export process so that you can resolve them quickly. A “Success” status indicates that data has been exported and will be available in connected Commerce services when the data sync process completes.

NOTE
If the Data Feed Sync Status page is not available in the Commerce Admin for Commerce on Cloud or on premises deployments, follow the extension installation instructions to enable it.
recommendation-more-help
commerce-help-catalog-service