close

Filter

loading table of contents...

Headless Server Developer Manual / Version 2101

Table Of Contents

6. eCommerce Extension

All eCommerce functionality of the Headless Server is bundled within the Blueprint module headless-server-ec. It contains a GraphQL schema extension within the file commerce-schema.graphql and Java code and Spring configuration to implement this schema extension.

The GraphQL schema extension is essentially a mapping of the CoreMedia Commerce API onto GraphQL terms, with some additions to support augmented products and categories.

The schema extension uses the GraphQL extension mechanism to add a new field commerce of type CommerceRoot to the query root object. Using this new root field, it is possible to query for catalogs, categories and products, including product variants.

eCommerce catalogs are always associated with a specific site, so you have to specify a site ID in each CommerceRootquery.

Note

Commerce Headless Schema Deprecation

The commerce-related schema extensions that primarily serve pure eCommerce data like product or category details are going to be removed from the CoreMedia headless server in a future AEP. Retrieve commerce data directly from the commerce system or create a combined custom schema via schema federation or schema stitching instead. Additionally, CoreMedia will add dedicated augmentation queries to retrieve content augmentation data for commerce objects but without pulling the commerce object detail data from the commerce system. The affected schema extensions (entities, queries and fields) are marked as deprecated.

Categories may also be queried by their SEO segment.

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.