Adobe Commerce Merchandising Services Documentation

This repository contains the code for the Merchandising Services documentation website. It is built using Adobe Edge Delivery Services and deployed to Adobe Developer.

The site covers APIs and tools for managing and using commerce catalog and event data programmatically, including the Data Ingestion API, Merchandising API, Storefront Events SDK, Product Recommendations SDK, and Commerce Reporting API.

Quick start

For local development, you need to start three servers:

1. Content server (this repo):

   npm run dev

2. Code server (adp-devsite):

   git clone https://github.com/AdobeDocs/adp-devsite
   cd adp-devsite
   npm install
   npm run dev

3. Runtime connector (devsite-runtime-connector):

   git clone https://github.com/aemsites/devsite-runtime-connector
   cd devsite-runtime-connector
   npm install
   npm run dev

Once all three servers are running, navigate to http://localhost:3000/commerce/services.

For common utilities and documentation, see the centralized README.

Testing and linting

Markdown linting

To lint Markdown files before pushing:

npm run lint:md

To automatically fix linting errors:

npm run lint:md:fix

Content validation

To check internal and external links, validate front matter, and more:

npm run lint

TOC validation

To validate the table of contents file:

npm run test:config

GraphQL API reference

The Merchandising GraphQL API reference is generated using SpectaQL. It introspects the live schema, injects custom descriptions from a metadata overlay, and filters the output to include only the queries and types supported by Adobe Commerce Optimizer.

The generated Markdown fragment is written to src/pages/_includes/merchandising-api.md and included in src/pages/reference/graphql/index.md via <Fragment>.

Generating the reference

1. Create a .env file in the project root and set the required variables:

   Variable	Description
   TENANT_ID	Your Adobe Commerce tenant ID
   API_HOST	GraphQL API hostname
   CATALOG_VIEW_ID	Catalog view ID for the AC-View-Id header

2. Run the generator:

   npm run generate:merchandising-api-docs

See spectaql/README.md for full configuration and script documentation.