GraphQL API now available — more efficient integrations and queries

AI Commerce Cloud offers a GraphQL API, providing a flexible and efficient way to query data from the platform. GraphQL is particularly valuable because it allows partners to define exactly what data they need, reducing unnecessary data transfers and speeding up request handling.

How does GraphQL work in AI Commerce Cloud?

AI Commerce Cloud uses an Apollo GraphQL server that processes requests and returns only the requested data. Partners can use GraphQL to retrieve products, countries, and other data from the AI Commerce Cloud platform. GraphQL requests are made via HTTP POST and require correct authentication headers.

Example GraphQL request

GraphQL requests are made in JSON format using the load balancer endpoint obtained from the APP_LOAD_BALANCER_URL environment variable. For example, to retrieve five products:

Required headers

Each GraphQL request must include the following headers:

• X-GraphQL-Secret: AI Commerce security key.

• X-Tenant-Id: Store alias.

• X-Tenant-Secret: Tenant API key.

• Content-Type: application/json.

Summary

GraphQL is a powerful and flexible way to query data from AI Commerce Cloud. We recommend using AI Commerce Cloud’s Lambda load balancer to enhance security.

More detailed information on the GraphQL API is available in our knowledge base documentation.