# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klaviyo Catalogs API
  version: 1.0.0
extends: openapi/klaviyo-catalogs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 55
- target: $.paths['/api/catalog-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog items in the account
      effect: read
      questions:
      - What products are in my Klaviyo catalog right now?
      - Can I sort my catalog items by when they were created?
      - Which catalog items match a particular set of item IDs?
      instructions:
      - text: List catalog items matching {filter}.
        slots:
          filter: query.filter
      - text: Show catalog items sorted by {sort}, including their variants.
        slots:
          sort: query.sort
      - text: List every product item in my catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new product to the catalog
      effect: write
      questions:
      - How do I add a single new product to my catalog?
      - Can I create one catalog item with its title, price and URL?
      instructions:
      - text: Create a catalog item from {item}.
        slots:
          item: requestBody.data
      - text: 'Add this product to the catalog as a new item: {item}.'
        slots:
          item: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one catalog item
      effect: read
      questions:
      - What are the details of a specific product in my catalog?
      - Can I fetch one catalog item along with its variants?
      instructions:
      - text: Get catalog item {item_id}.
        slots:
          item_id: path.id
      - text: Show the details and variants of catalog item {item_id}.
        slots:
          item_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog item
      effect: destructive
      questions:
      - Can I remove a single product from my catalog?
      - What happens when I delete one catalog item by its ID?
      instructions:
      - text: Delete catalog item {item_id}.
        slots:
          item_id: path.id
      - text: Remove product {item_id} from the catalog.
        slots:
          item_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog item
      effect: write
      questions:
      - How do I change the price or title of an existing catalog product?
      - Can I edit one catalog item that's already in my catalog?
      instructions:
      - text: Update catalog item {item_id} with {changes}.
        slots:
          item_id: path.id
          changes: requestBody.data
      - text: Change the details of existing product {item_id} to {changes}.
        slots:
          item_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List all catalog variants
      effect: read
      questions:
      - What product variants exist across my whole catalog?
      - Can I filter all catalog variants in the account by SKU or ID?
      instructions:
      - text: List all catalog variants matching {filter}.
        slots:
          filter: query.filter
      - text: Show every variant across all items in my catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a variant to a catalog item
      effect: write
      questions:
      - How do I add a size or color variant to a catalog product?
      - Can I create one variant for an existing catalog item?
      instructions:
      - text: Create catalog variant {variant}.
        slots:
          variant: requestBody.data
      - text: 'Add this new variant to its catalog item: {variant}.'
        slots:
          variant: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one catalog variant
      effect: read
      questions:
      - What are the details of a specific product variant?
      - Can I look up a single variant's price and inventory?
      instructions:
      - text: Get catalog variant {variant_id}.
        slots:
          variant_id: path.id
      - text: Show the inventory and price for variant {variant_id}.
        slots:
          variant_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog variant
      effect: destructive
      questions:
      - Can I delete a single variant without deleting its product?
      - What happens to a product when one of its variants is removed?
      instructions:
      - text: Delete catalog variant {variant_id}.
        slots:
          variant_id: path.id
      - text: Remove variant {variant_id} from its catalog item.
        slots:
          variant_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variants/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog variant
      effect: write
      questions:
      - How do I update the inventory quantity of one variant?
      - Can I change the price of an existing variant?
      instructions:
      - text: Update catalog variant {variant_id} with {changes}.
        slots:
          variant_id: path.id
          changes: requestBody.data
      - text: 'Set new inventory and price on variant {variant_id}: {changes}.'
        slots:
          variant_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog categories
      effect: read
      questions:
      - What categories are set up in my product catalog?
      - Can I find catalog categories by name?
      instructions:
      - text: List catalog categories matching {filter}.
        slots:
          filter: query.filter
      - text: Show all the categories in my catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a catalog category
      effect: write
      questions:
      - How do I create a new product category in my catalog?
      - Can I add one category like 'Summer Sale' to the catalog?
      instructions:
      - text: Create catalog category {category}.
        slots:
          category: requestBody.data
      - text: 'Add a new category to the catalog: {category}.'
        slots:
          category: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one catalog category
      effect: read
      questions:
      - What are the details of a single catalog category?
      - Can I look up a category by its ID?
      instructions:
      - text: Get catalog category {category_id}.
        slots:
          category_id: path.id
      - text: Show the name and details of category {category_id}.
        slots:
          category_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog category
      effect: destructive
      questions:
      - Can I delete one category from my catalog?
      - What happens when I remove a catalog category by ID?
      instructions:
      - text: Delete catalog category {category_id}.
        slots:
          category_id: path.id
      - text: Remove category {category_id} from the catalog.
        slots:
          category_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a catalog category
      effect: write
      questions:
      - How do I rename an existing catalog category?
      - Can I edit the details of one category?
      instructions:
      - text: Update catalog category {category_id} with {changes}.
        slots:
          category_id: path.id
          changes: requestBody.data
      - text: Rename category {category_id} using {changes}.
        slots:
          category_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-create-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk item-create jobs
      effect: read
      questions:
      - Which bulk catalog item create jobs have I run?
      - Can I see only the item-create jobs that are still processing?
      instructions:
      - text: List bulk catalog item create jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that created catalog items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-create-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many catalog items in one job
      effect: write
      questions:
      - How do I import up to 100 products into my catalog at once?
      - What's the payload limit for a bulk catalog item create job?
      instructions:
      - text: 'Start a bulk job creating these catalog items: {items}.'
        slots:
          items: requestBody.data
      - text: Bulk import products {items} into the catalog.
        slots:
          items: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-create-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk item-create job
      effect: read
      questions:
      - Did my bulk catalog item import job finish?
      - Can I see which items a bulk create job produced?
      instructions:
      - text: Get the status of bulk item create job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the items created by bulk create job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-update-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk item-update jobs
      effect: read
      questions:
      - Which bulk catalog item update jobs have run in my account?
      - Can I filter item-update jobs by status?
      instructions:
      - text: List bulk catalog item update jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that updated catalog items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-update-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Update many catalog items in one job
      effect: write
      questions:
      - How do I update prices on a batch of catalog items at once?
      - How many catalog items can one bulk update job change?
      instructions:
      - text: 'Start a bulk job updating these catalog items: {items}.'
        slots:
          items: requestBody.data
      - text: Bulk update existing products with {items}.
        slots:
          items: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-update-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk item-update job
      effect: read
      questions:
      - Has my bulk catalog item update job completed?
      - Can I see which items a bulk update job changed?
      instructions:
      - text: Get the status of bulk item update job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the items touched by bulk update job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-delete-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk item-delete jobs
      effect: read
      questions:
      - Which bulk catalog item delete jobs have I run?
      - Can I list only the failed item-delete jobs?
      instructions:
      - text: List bulk catalog item delete jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that deleted catalog items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-delete-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many catalog items in one job
      effect: destructive
      questions:
      - How do I remove a batch of discontinued products from my catalog?
      - How many catalog items can a single bulk delete job remove?
      instructions:
      - text: 'Start a bulk job deleting these catalog items: {items}.'
        slots:
          items: requestBody.data
      - text: Bulk delete products {items} from the catalog.
        slots:
          items: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-item-bulk-delete-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk item-delete job
      effect: read
      questions:
      - Did my bulk catalog item delete job succeed?
      - What's the status of a specific item-delete job?
      instructions:
      - text: Get the status of bulk item delete job {job_id}.
        slots:
          job_id: path.job_id
      - text: Check whether item delete job {job_id} has finished.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-create-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk variant-create jobs
      effect: read
      questions:
      - Which bulk variant create jobs have run in my catalog?
      - Can I filter variant-create jobs by their status?
      instructions:
      - text: List bulk variant create jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that created catalog variants.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-create-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many catalog variants in one job
      effect: write
      questions:
      - How do I add up to 100 variants to my catalog in one request?
      - Is there a size limit on a bulk variant create job?
      instructions:
      - text: 'Start a bulk job creating these variants: {variants}.'
        slots:
          variants: requestBody.data
      - text: Bulk add catalog variants {variants}.
        slots:
          variants: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-create-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk variant-create job
      effect: read
      questions:
      - Has my bulk variant create job finished?
      - Can I see the variants a bulk create job added?
      instructions:
      - text: Get the status of bulk variant create job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the variants created by job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-update-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk variant-update jobs
      effect: read
      questions:
      - Which bulk variant update jobs have I run?
      - Can I see only the variant-update jobs that completed?
      instructions:
      - text: List bulk variant update jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that updated catalog variants.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-update-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Update many catalog variants in one job
      effect: write
      questions:
      - How do I refresh inventory counts on a batch of variants at once?
      - How many variants can one bulk update job modify?
      instructions:
      - text: 'Start a bulk job updating these variants: {variants}.'
        slots:
          variants: requestBody.data
      - text: Bulk update variant inventory and prices with {variants}.
        slots:
          variants: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-update-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk variant-update job
      effect: read
      questions:
      - Did my bulk variant update job complete?
      - Can I see which variants a bulk update job changed?
      instructions:
      - text: Get the status of bulk variant update job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the variants modified by update job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-delete-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk variant-delete jobs
      effect: read
      questions:
      - Which bulk variant delete jobs exist in my account?
      - Can I filter variant-delete jobs by status?
      instructions:
      - text: List bulk variant delete jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that deleted catalog variants.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-delete-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many catalog variants in one job
      effect: destructive
      questions:
      - How do I delete a batch of sold-out variants at once?
      - What's the maximum number of variants one bulk delete job can remove?
      instructions:
      - text: 'Start a bulk job deleting these variants: {variants}.'
        slots:
          variants: requestBody.data
      - text: Bulk remove catalog variants {variants}.
        slots:
          variants: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-variant-bulk-delete-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk variant-delete job
      effect: read
      questions:
      - Has my bulk variant delete job finished?
      - What's the status of a particular variant-delete job?
      instructions:
      - text: Get the status of bulk variant delete job {job_id}.
        slots:
          job_id: path.job_id
      - text: Check whether variant delete job {job_id} is done.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-create-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk category-create jobs
      effect: read
      questions:
      - Which bulk category create jobs have I run?
      - Can I filter category-create jobs by status?
      instructions:
      - text: List bulk category create jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that created catalog categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-create-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many catalog categories in one job
      effect: write
      questions:
      - How do I set up a batch of catalog categories in one request?
      - How many categories can a bulk create job accept?
      instructions:
      - text: 'Start a bulk job creating these categories: {categories}.'
        slots:
          categories: requestBody.data
      - text: Bulk add catalog categories {categories}.
        slots:
          categories: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-create-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk category-create job
      effect: read
      questions:
      - Did my bulk category create job finish?
      - Can I see the categories a bulk create job made?
      instructions:
      - text: Get the status of bulk category create job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the categories created by job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-update-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk category-update jobs
      effect: read
      questions:
      - Which bulk category update jobs have run?
      - Can I list only the category-update jobs still in progress?
      instructions:
      - text: List bulk category update jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that updated catalog categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-update-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Update many catalog categories in one job
      effect: write
      questions:
      - How do I rename a batch of catalog categories at once?
      - Is there a limit on categories per bulk update job?
      instructions:
      - text: 'Start a bulk job updating these categories: {categories}.'
        slots:
          categories: requestBody.data
      - text: Bulk update catalog categories with {categories}.
        slots:
          categories: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-update-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk category-update job
      effect: read
      questions:
      - Has my bulk category update job completed?
      - Can I see which categories a bulk update job changed?
      instructions:
      - text: Get the status of bulk category update job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the categories modified by update job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-delete-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk category-delete jobs
      effect: read
      questions:
      - Which bulk category delete jobs have I run?
      - Can I filter category-delete jobs by status?
      instructions:
      - text: List bulk category delete jobs with status {filter}.
        slots:
          filter: query.filter
      - text: Show my past bulk jobs that deleted catalog categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-delete-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many catalog categories in one job
      effect: destructive
      questions:
      - How do I remove several old catalog categories in one go?
      - How many categories can a single bulk delete job remove?
      instructions:
      - text: 'Start a bulk job deleting these categories: {categories}.'
        slots:
          categories: requestBody.data
      - text: Bulk remove catalog categories {categories}.
        slots:
          categories: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-category-bulk-delete-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk category-delete job
      effect: read
      questions:
      - Did my bulk category delete job succeed?
      - What's the status of one category-delete job?
      instructions:
      - text: Get the status of bulk category delete job {job_id}.
        slots:
          job_id: path.job_id
      - text: Check whether category delete job {job_id} is complete.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/back-in-stock-subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a shopper to back-in-stock alerts
      effect: write
      questions:
      - How do I notify a customer when an out-of-stock variant is available again?
      - Can my server sign a profile up for back in stock notifications?
      instructions:
      - text: Subscribe {subscription} to back in stock alerts from my server.
        slots:
          subscription: requestBody.data
      - text: 'Create a server-side back in stock subscription: {subscription}.'
        slots:
          subscription: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in a catalog category
      effect: read
      questions:
      - Which products are in a particular catalog category?
      - Can I get the full item details for everything in one category?
      instructions:
      - text: List the catalog items in category {category_id}.
        slots:
          category_id: path.id
      - text: Show full product details for items in category {category_id}, sorted by {sort}.
        slots:
          category_id: path.id
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}/relationships/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List item IDs in a catalog category
      effect: read
      questions:
      - Can I get just the IDs of the items in a category?
      - What item IDs belong to one catalog category?
      instructions:
      - text: Get only the item IDs in category {category_id}.
        slots:
          category_id: path.id
      - text: Return the item ID list for category {category_id}.
        slots:
          category_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}/relationships/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add items to a catalog category
      effect: write
      questions:
      - How do I put existing products into a category?
      - Can I add several items to one category at once?
      instructions:
      - text: Add items {items} to category {category_id}.
        slots:
          items: requestBody.data
          category_id: path.id
      - text: Put products {items} into catalog category {category_id}.
        slots:
          items: requestBody.data
          category_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}/relationships/items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove items from a catalog category
      effect: destructive
      questions:
      - How do I take products out of a category without deleting them?
      - Can I unlink several items from one category?
      instructions:
      - text: Remove items {items} from category {category_id}.
        slots:
          items: requestBody.data
          category_id: path.id
      - text: Take products {items} out of catalog category {category_id}.
        slots:
          items: requestBody.data
          category_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-categories/{id}/relationships/items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace the item set of a catalog category
      effect: write
      questions:
      - Can I overwrite a category's item membership with a new list?
      - How do I reset which items are in a category?
      instructions:
      - text: Replace the items in category {category_id} with {items}.
        slots:
          items: requestBody.data
          category_id: path.id
      - text: Set category {category_id} to contain exactly {items}.
        slots:
          items: requestBody.data
          category_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List the variants of a catalog item
      effect: read
      questions:
      - What variants does a particular product have?
      - Can I see full variant details for one catalog item?
      instructions:
      - text: List the variants of catalog item {item_id}.
        slots:
          item_id: path.id
      - text: Show every size and color variant for product {item_id}.
        slots:
          item_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/relationships/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List variant IDs for a catalog item
      effect: read
      questions:
      - Can I get only the variant IDs for one product?
      - Which variant IDs are attached to a catalog item?
      instructions:
      - text: Get only the variant IDs of catalog item {item_id}.
        slots:
          item_id: path.id
      - text: Return the variant ID list for product {item_id}.
        slots:
          item_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List the categories an item belongs to
      effect: read
      questions:
      - Which categories is a specific product in?
      - Can I see full category details for one catalog item?
      instructions:
      - text: List the categories that catalog item {item_id} is in.
        slots:
          item_id: path.id
      - text: Show category details for product {item_id}.
        slots:
          item_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/relationships/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List category IDs for a catalog item
      effect: read
      questions:
      - Can I get just the category IDs for one product?
      - What category IDs is a catalog item linked to?
      instructions:
      - text: Get only the category IDs for catalog item {item_id}.
        slots:
          item_id: path.id
      - text: Return the category ID list for product {item_id}.
        slots:
          item_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/relationships/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a catalog item to categories
      effect: write
      questions:
      - How do I place one product into additional categories?
      - Can I link a catalog item to several categories at once?
      instructions:
      - text: Add catalog item {item_id} to categories {categories}.
        slots:
          item_id: path.id
          categories: requestBody.data
      - text: Link product {item_id} to categories {categories}.
        slots:
          item_id: path.id
          categories: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/relationships/categories'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a catalog item from categories
      effect: destructive
      questions:
      - How do I take one product out of some of its categories?
      - Can I unlink a catalog item from several categories?
      instructions:
      - text: Remove catalog item {item_id} from categories {categories}.
        slots:
          item_id: path.id
          categories: requestBody.data
      - text: Unlink product {item_id} from categories {categories}.
        slots:
          item_id: path.id
          categories: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/catalog-items/{id}/relationships/categories'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace a catalog item's categories
      effect: write
      questions:
      - Can I overwrite all the categories a product belongs to?
      - How do I reset one item's category assignments?
      instructions:
      - text: Replace the categories of catalog item {item_id} with {categories}.
        slots:
          item_id: path.id
          categories: requestBody.data
      - text: Set product {item_id} to belong only to {categories}.
        slots:
          item_id: path.id
          categories: requestBody.data
      method: generated
      generated: '2026-09-26'