Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Ajax Product Recommendations API

2 actions 2 updates phrasing extends openapi/shopify-product-recommendations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/recommendations/products.json'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Ajax Product Recommendations API
  version: 1.0.0
extends: openapi/shopify-product-recommendations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/recommendations/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recommended products for a product
      effect: read
      questions:
      - How can I show 'you may also like' products on a product page?
      - Can I get complementary products instead of related ones, and cap how many come back?
      - What's the most recommendations I can request for one product?
      instructions:
      - text: Get product recommendations for product {product_id}.
        slots:
          product_id: query.product_id
      - text: Show {limit} {intent} recommendations for product {product_id}.
        slots:
          limit: query.limit
          intent: query.intent
          product_id: query.product_id
      method: generated
      generated: '2026-09-24'