Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Custom Collections API

3 actions 3 updates phrasing extends openapi/shopify-custom-collections-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 3

$.info
$.paths['/custom_collections.json'].get
$.paths['/custom_collections.json'].post

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 Admin REST Custom Collections API
  version: 1.0.0
extends: openapi/shopify-custom-collections-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: 2
- target: $.paths['/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections
      effect: read
      questions:
      - Which manual collections have I set up in my Shopify store?
      - Can I find the custom collections that a particular product belongs to?
      instructions:
      - text: List my custom collections.
      - text: Show custom collections that contain product {product_id}.
        slots:
          product_id: query.product_id
      - text: Find custom collections titled {title}, {limit} per page.
        slots:
          title: query.title
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/custom_collections.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom collection
      effect: write
      questions:
      - How do I create a new hand-picked collection in my store?
      - Can I set up a manual collection instead of one driven by rules?
      instructions:
      - text: Create a custom collection from {custom_collection}.
        slots:
          custom_collection: requestBody.custom_collection
      - text: 'Add a new manual collection with these details: {custom_collection}.'
        slots:
          custom_collection: requestBody.custom_collection
      method: generated
      generated: '2026-09-24'